meshagent
--install-completion
: Install completion for the current shell.--show-completion
: Show completion for the current shell, to copy it or customize the installation.--help
: Show this message and exit.exec
: Open an interactive websocket‑based TTY.version
: Print the versionenv
: Generate shell commands to set meshagent…setup
: Perform initial login and project/api key…call
auth
: Authenticate to meshagentproject
: Manage or activate your meshagent projectsapi-key
: Manage or activate api-keys for your projectsession
participant-token
agents
messaging
storage
: Manage storage for a roomdeveloper
webhook
service
: Manage services for your projectsecret
: Manage secrets for your project.queue
: Use queues in a roommcp
chatbot
: Join a chatbot to a roomvoicebot
: Join a voicebot to a roommailbot
: Join a mailbot to a roommeshagent exec
[COMMAND]...
--project-id TEXT
--room TEXT
: [required]--name TEXT
--image TEXT
--api-key-id TEXT
--tty / --no-tty
: [default: no-tty]--room-storage-path TEXT
: [default: /data]--help
: Show this message and exit.meshagent version
--help
: Show this message and exit.meshagent env
--shell TEXT
: bash | zsh | fish | powershell | cmd--unset
: Output commands to unset the variables.--help
: Show this message and exit.meshagent setup
--help
: Show this message and exit.meshagent call
--help
: Show this message and exit.tool
: Instruct an agent to ‘call’ a given URL…agent
: Instruct an agent to ‘call’ a given URL…toolkit
: Instruct an agent to ‘call’ a given URL…schema
: Instruct an agent to ‘call’ a given URL…meshagent call tool
--project-id TEXT
--room TEXT
: [required]--api-key-id TEXT
--role TEXT
: [default: agent]--local / --no-local
--participant-name TEXT
: the participant name to be used by the callee--url TEXT
: URL the agent should call [required]--arguments TEXT
: JSON string with arguments for the call [default: ]--help
: Show this message and exit.meshagent call agent
--project-id TEXT
--room TEXT
: [required]--api-key-id TEXT
--role TEXT
: [default: agent]--local / --no-local
--participant-name TEXT
: the participant name to be used by the callee--url TEXT
: URL the agent should call [required]--arguments TEXT
: JSON string with arguments for the call [default: ]--help
: Show this message and exit.meshagent call toolkit
--project-id TEXT
--room TEXT
: [required]--api-key-id TEXT
--role TEXT
: [default: agent]--local / --no-local
--participant-name TEXT
: the participant name to be used by the callee--url TEXT
: URL the agent should call [required]--arguments TEXT
: JSON string with arguments for the call [default: ]--help
: Show this message and exit.meshagent call schema
--project-id TEXT
--room TEXT
: [required]--api-key-id TEXT
--role TEXT
: [default: agent]--local / --no-local
--participant-name TEXT
: the participant name to be used by the callee--url TEXT
: URL the agent should call [required]--arguments TEXT
: JSON string with arguments for the call [default: ]--help
: Show this message and exit.meshagent auth
--help
: Show this message and exit.login
logout
whoami
meshagent auth login
--help
: Show this message and exit.meshagent auth logout
--help
: Show this message and exit.meshagent auth whoami
--help
: Show this message and exit.meshagent project
--help
: Show this message and exit.create
list
activate
meshagent project create
NAME
: [required]--help
: Show this message and exit.meshagent project list
-o, --output TEXT
: output format [default: table]--help
: Show this message and exit.meshagent project activate
[PROJECT_ID]
-i, --interactive
: Interactively select or create a project--help
: Show this message and exit.meshagent api-key
--help
: Show this message and exit.list
create
delete
show
activate
meshagent api-key list
--project-id TEXT
-o, --output TEXT
: output format [default: table]--help
: Show this message and exit.meshagent api-key create
NAME
: [required]--project-id TEXT
--description TEXT
--help
: Show this message and exit.meshagent api-key delete
ID
: [required]--project-id TEXT
--help
: Show this message and exit.meshagent api-key show
API_KEY_ID
: [required]--project-id TEXT
--help
: Show this message and exit.meshagent api-key activate
[API_KEY_ID]
--project-id TEXT
-i, --interactive
: Interactively select or create an api key--help
: Show this message and exit.meshagent session
--help
: Show this message and exit.list
show
meshagent session list
--project-id TEXT
--help
: Show this message and exit.meshagent session show
SESSION_ID
: [required]--project-id TEXT
--help
: Show this message and exit.meshagent participant-token
--help
: Show this message and exit.generate
meshagent participant-token generate
--project-id TEXT
--token-path TEXT
: [required]--room TEXT
: [required]--api-key-id TEXT
--name TEXT
: [required]--role TEXT
: [default: agent]--help
: Show this message and exit.meshagent agents
--help
: Show this message and exit.ask
invoke-tool
: Invoke a specific tool from a given…list-agents
: List all agents available in the room.list-toolkits
: List all toolkits (and tools within them)…meshagent agents ask
--project-id TEXT
--room TEXT
: [required]--api-key-id TEXT
--name TEXT
: Participant name [default: cli]--role TEXT
: [default: user]--agent TEXT
: [required]--input TEXT
: [required]--timeout INTEGER
: How long to wait for the agent if the agent is not in the room [default: 30]--help
: Show this message and exit.meshagent agents invoke-tool
--project-id TEXT
--room TEXT
: [required]--token-path TEXT
--api-key-id TEXT
--name TEXT
: Participant name [default: cli]--role TEXT
: [default: user]--toolkit TEXT
: Toolkit name [required]--tool TEXT
: Tool name [required]--arguments TEXT
: JSON string with arguments for the tool [required]--participant-id TEXT
: Optional participant ID to invoke the tool on--on-behalf-of-id TEXT
: Optional ‘on_behalf_of’ participant ID--caller-context TEXT
: Optional JSON for caller context--timeout INTEGER
: How long to wait for the toolkit if the toolkit is not in the room [default: 30]--help
: Show this message and exit.meshagent agents list-agents
--project-id TEXT
--room TEXT
: [required]--token-path TEXT
--api-key-id TEXT
--name TEXT
: Participant name [default: cli]--role TEXT
: [default: user]--help
: Show this message and exit.meshagent agents list-toolkits
--project-id TEXT
--room TEXT
: [required]--token-path TEXT
--api-key-id TEXT
--name TEXT
: Participant name [default: cli]--role TEXT
: [default: user]--participant-id TEXT
: Optional participant ID--help
: Show this message and exit.meshagent messaging
--help
: Show this message and exit.list-participants
: List all messaging-enabled participants in…send
: Send a direct message to a single…broadcast
: Broadcast a message to all…meshagent messaging list-participants
--project-id TEXT
--room TEXT
--token-path TEXT
--api-key-id TEXT
--name TEXT
: [default: cli]--role TEXT
: [default: user]--help
: Show this message and exit.meshagent messaging send
--project-id TEXT
--room TEXT
--token-path TEXT
--api-key-id TEXT
--name TEXT
: [default: cli]--role TEXT
: [default: user]--to-participant-id TEXT
: Participant ID to send a message to [required]--data TEXT
: JSON message to send [required]--help
: Show this message and exit.meshagent messaging broadcast
--project-id TEXT
--room TEXT
--token-path TEXT
--api-key-id TEXT
--name TEXT
: [default: cli]--role TEXT
: [default: user]--data TEXT
: JSON message to broadcast [required]--help
: Show this message and exit.meshagent storage
--help
: Show this message and exit.exists
: Check if a file/folder exists in remote…cp
show
: Print the contents of a file (local or…rm
: Remove files (and optionally folders)…ls
: List files/folders either locally or in…meshagent storage exists
PATH
: [required]--project-id TEXT
--room TEXT
: Room name [required]--token-path TEXT
--api-key-id TEXT
: API Key ID--name TEXT
: Participant name [default: cli]--role TEXT
: [default: user]--help
: Show this message and exit.meshagent storage cp
SOURCE_PATH
: [required]DEST_PATH
: [required]--project-id TEXT
--room TEXT
: Room name (if copying to/from remote) [required]--token-path TEXT
--api-key-id TEXT
: API Key ID (if copying to/from remote)--name TEXT
: Participant name (if copying to/from remote) [default: cli]--role TEXT
: [default: user]--help
: Show this message and exit.meshagent storage show
PATH
: [required]--project-id TEXT
: Project ID (if remote)--room TEXT
: Room name (if remote)--token-path TEXT
--api-key-id TEXT
: API Key ID (if remote)--name TEXT
: Participant name (if remote)--role TEXT
: [default: user]--encoding TEXT
: Text encoding [default: utf-8]--help
: Show this message and exit.meshagent storage rm
PATH
: [required]--project-id TEXT
: Project ID (if remote)--room TEXT
: Room name (if remote)--token-path TEXT
--api-key-id TEXT
: API Key ID (if remote)--name TEXT
: Participant name (if remote)--role TEXT
: [default: user]-r
: Remove directories/folders recursively--help
: Show this message and exit.meshagent storage ls
PATH
: Path to list (local or room://…) [required]--project-id TEXT
: Project ID (if remote)--room TEXT
: Room name (if remote)--token-path TEXT
--api-key-id TEXT
: API Key ID (if remote)--name TEXT
: Participant name (if remote)--role TEXT
: [default: user]-r
: List subfolders/files recursively--help
: Show this message and exit.meshagent developer
--help
: Show this message and exit.watch
: Watch logs from the developer feed in the…meshagent developer watch
--project-id TEXT
: Project ID (if not set, will try to use the active project)--room TEXT
: Name of the room to connect to [required]--api-key-id TEXT
: API Key ID--name TEXT
: Participant name [default: cli]--role TEXT
: Role to assign to this participant [default: user]--help
: Show this message and exit.meshagent webhook
--help
: Show this message and exit.create
: Create a new project webhook.list
: List all webhooks for the project.delete
: Delete a project webhook.meshagent webhook create
--project-id TEXT
--name TEXT
: Friendly name for the webhook [required]--url TEXT
: Target URL that will receive POSTs [required]-e, --event TEXT
: Event to subscribe to (repeat for multiple). [required] TEXT
: Optional description--action TEXT
: Optional action name delivered with each call--payload TEXT
: Optional JSON string sent as the body (merged with event payload).--help
: Show this message and exit.meshagent webhook list
--project-id TEXT
--help
: Show this message and exit.meshagent webhook delete
WEBHOOK_ID
: ID of the webhook to delete [required]--project-id TEXT
--help
: Show this message and exit.meshagent service
--help
: Show this message and exit.create
: Create a service attached to the project.update
: Create a service attached to the project.test
: Create a service attached to the project.show
: Show a services for the project.list
: List all services for the project.delete
: Delete a service.meshagent service create
--project-id TEXT
-f, --file TEXT
: File path to a service definition--name TEXT
: Friendly service name--image TEXT
: Container image reference--role TEXT
: Service role (agent|tool)--pull-secret TEXT
: Secret ID for registry--command TEXT
: Override ENTRYPOINT/CMD-e, --env TEXT
: KEY=VALUE--env-secret TEXT
--runtime-secret TEXT
--mount TEXT
: Path inside container to mount room storage--mount-subpath TEXT
: Restrict the container’s mount to a subpath within the room storage-p, --port TEXT
: Repeatable. Example:
-p “num=8080 type= liveness=/health path=/agent participant_name=myname”--help
: Show this message and exit.meshagent service update
--project-id TEXT
--id TEXT
-f, --file TEXT
: File path to a service definition--name TEXT
: Friendly service name--image TEXT
: Container image reference--role TEXT
: Service role (agent|tool)--pull-secret TEXT
: Secret ID for registry--command TEXT
: Override ENTRYPOINT/CMD-e, --env TEXT
: KEY=VALUE--env-secret TEXT
--runtime-secret TEXT
--mount TEXT
: Path inside container to mount room storage--mount-subpath TEXT
: Restrict the container’s mount to a subpath within the room storage-p, --port TEXT
: Repeatable. Example:
-p “num=8080 type= liveness=/health path=/agent participant_name=myname”--create / --no-create
: create the service if it does not exist [default: no-create]--help
: Show this message and exit.meshagent service test
--project-id TEXT
--api-key-id TEXT
-f, --file TEXT
: File path to a service definition [required]--room TEXT
: A room name to test the service in (must not be currently running)--name TEXT
: Friendly service name--role TEXT
: Service role (agent|tool)--image TEXT
: Container image reference--pull-secret TEXT
: Secret ID for registry--command TEXT
: Override ENTRYPOINT/CMD-e, --env TEXT
: KEY=VALUE--env-secret TEXT
--runtime-secret TEXT
--mount TEXT
: Path inside container to mount room storage-p, --port TEXT
: Repeatable. Example:
-p “num=8080 type= liveness=/health path=/agent participant_name=myname”--timeout INTEGER
: The maximum time that this room should run (default 1hr)--help
: Show this message and exit.meshagent service show
SERVICE_ID
: ID of the service to delete [required]--project-id TEXT
--help
: Show this message and exit.meshagent service list
--project-id TEXT
-o, --output TEXT
: output format [default: table]--help
: Show this message and exit.meshagent service delete
SERVICE_ID
: ID of the service to delete [required]--project-id TEXT
--help
: Show this message and exit.meshagent secret
--help
: Show this message and exit.list
: List all secrets in the project (typed as…delete
: Delete a secret.keys
: Create or update environment-based…docker
: Create or update a Docker registry pull…acr
: Create or update an Azure Container…gar
: Create or update a Google Artifact…meshagent secret list
--project-id TEXT
--help
: Show this message and exit.meshagent secret delete
SECRET_ID
: ID of the secret to delete [required]--project-id TEXT
--help
: Show this message and exit.meshagent secret keys
--help
: Show this message and exit.create
: Create a new ‘keys’ secret (opaque env-vars).update
: Update an existing ‘keys’ secret (opaque…meshagent secret keys create
--project-id TEXT
--name TEXT
: Secret name [required]--data TEXT
: Format: key=value key2=value (space-separated) [required]--help
: Show this message and exit.meshagent secret keys update
--project-id TEXT
--secret-id TEXT
: Existing secret ID [required]--name TEXT
: Secret name [required]--data TEXT
: Format: key=value key2=value (space-separated) [required]--help
: Show this message and exit.meshagent secret docker
--help
: Show this message and exit.create
: Create a new Docker pull secret (generic).update
: Update an existing Docker pull secret…meshagent secret docker create
--project-id TEXT
--name TEXT
: Secret name [required]--server TEXT
: Docker registry server, e.g. index.docker.io [required]--username TEXT
: Registry user name [required]--password TEXT
: Registry password [required]--email TEXT
: User email for Docker config--help
: Show this message and exit.meshagent secret docker update
--project-id TEXT
--secret-id TEXT
: Existing secret ID [required]--name TEXT
: Secret name [required]--server TEXT
: Docker registry server [required]--username TEXT
: Registry user name [required]--password TEXT
: Registry password [required]--email TEXT
: User email for Docker config--help
: Show this message and exit.meshagent secret acr
--help
: Show this message and exit.create
: Create a new ACR pull secret (defaults…update
: Update an existing ACR pull secret…meshagent secret acr create
--project-id TEXT
--name TEXT
: Secret name [required]--server TEXT
: ACR server, e.g. myregistry.azurecr.io [required]--username TEXT
: Service principal ID [required]--password TEXT
: Service principal secret/password [required]--help
: Show this message and exit.meshagent secret acr update
--project-id TEXT
--secret-id TEXT
: Existing secret ID [required]--name TEXT
: Secret name [required]--server TEXT
: ACR server, e.g. myregistry.azurecr.io [required]--username TEXT
: Service principal ID [required]--password TEXT
: Service principal secret/password [required]--help
: Show this message and exit.meshagent secret gar
--help
: Show this message and exit.create
: Create a new Google Artifact Registry pull…update
: Update an existing Google Artifact…meshagent secret gar create
--project-id TEXT
--name TEXT
: Secret name [required]--server TEXT
: GAR host, e.g. us-west1-docker.pkg.dev [required]--json-key TEXT
: Entire GCP service account JSON as string [required]--help
: Show this message and exit.meshagent secret gar update
--project-id TEXT
--secret-id TEXT
: Existing secret ID [required]--name TEXT
: Secret name [required]--server TEXT
: GAR host, e.g. us-west1-docker.pkg.dev [required]--json-key TEXT
: Entire GCP service account JSON as string [required]--help
: Show this message and exit.meshagent queue
--help
: Show this message and exit.send
receive
meshagent queue send
--project-id TEXT
--room TEXT
: [required]--api-key-id TEXT
--name TEXT
: Participant name [default: cli]--role TEXT
: [default: user]--queue TEXT
: Queue name [required]--json TEXT
: a JSON message to send to the queue [required]-f, --file TEXT
: File path to a JSON file--help
: Show this message and exit.meshagent queue receive
--project-id TEXT
--room TEXT
: [required]--api-key-id TEXT
--name TEXT
: Participant name [default: cli]--role TEXT
: [default: user]--queue TEXT
: Queue name [required]--help
: Show this message and exit.meshagent mcp
--help
: Show this message and exit.sse
stdio
http-proxy
sse-proxy
stdio-service
meshagent mcp sse
--project-id TEXT
--room TEXT
: [required]--token-path TEXT
--api-key-id TEXT
--name TEXT
: Participant name [default: cli]--role TEXT
: [default: tool]--url TEXT
: [required]--toolkit-name TEXT
--help
: Show this message and exit.meshagent mcp stdio
--project-id TEXT
--room TEXT
: [required]--token-path TEXT
--api-key-id TEXT
--name TEXT
: Participant name [default: cli]--role TEXT
: [default: tool]--command TEXT
: [required]--toolkit-name TEXT
-e, --env TEXT
: KEY=VALUE--help
: Show this message and exit.meshagent mcp http-proxy
--command TEXT
: [required]--host TEXT
--port INTEGER
--path TEXT
--name TEXT
-e, --env TEXT
: KEY=VALUE--help
: Show this message and exit.meshagent mcp sse-proxy
--command TEXT
: [required]--host TEXT
--port INTEGER
--path TEXT
--name TEXT
-e, --env TEXT
: KEY=VALUE--help
: Show this message and exit.meshagent mcp stdio-service
--command TEXT
: [required]--host TEXT
--port INTEGER
--webhook-secret TEXT
--path TEXT
--toolkit-name TEXT
-e, --env TEXT
: KEY=VALUE--help
: Show this message and exit.meshagent chatbot
--help
: Show this message and exit.join
service
meshagent chatbot join
--project-id TEXT
--room TEXT
--api-key-id TEXT
--role TEXT
: [default: agent]--agent-name TEXT
: Name of the agent to call [required]--token-path TEXT
-r, --rule TEXT
: a system rule--rules-file TEXT
-t, --toolkit TEXT
: the name or url of a required toolkit-s, --schema TEXT
: the name or url of a required schema--model TEXT
: Name of the LLM model to use for the chatbot [default: gpt-4o]--image-generation TEXT
: Name of an image gen model--computer-use / --no-computer-use
: Enable computer use (requires computer-use-preview model) [default: no-computer-use]--local-shell / --no-local-shell
: Enable local shell tool calling [default: no-local-shell]--web-search / --no-web-search
: Enable web search tool calling [default: no-web-search]--help
: Show this message and exit.meshagent chatbot service
--room TEXT
--agent-name TEXT
: Name of the agent to call [required]-r, --rule TEXT
: a system rule--rules-file TEXT
-t, --toolkit TEXT
: the name or url of a required toolkit-s, --schema TEXT
: the name or url of a required schema--model TEXT
: Name of the LLM model to use for the chatbot [default: gpt-4o]--image-generation TEXT
: Name of an image gen model--local-shell / --no-local-shell
: Enable local shell tool calling [default: no-local-shell]--computer-use / --no-computer-use
: Enable computer use (requires computer-use-preview model) [default: no-computer-use]--web-search / --no-web-search
: Enable web search tool calling [default: no-web-search]--host TEXT
--port INTEGER
--path TEXT
: [default: /agent]--help
: Show this message and exit.meshagent voicebot
--help
: Show this message and exit.join
service
meshagent voicebot join
--project-id TEXT
--room TEXT
--api-key-id TEXT
--name TEXT
: Participant name [default: cli]--role TEXT
: [default: agent]--agent-name TEXT
: Name of the agent to call [required]-r, --rule TEXT
: a system rule--rules-file TEXT
-t, --toolkit TEXT
: the name or url of a required toolkit-s, --schema TEXT
: the name or url of a required schema--auto-greet-message TEXT
--auto-greet-prompt TEXT
--token-path TEXT
--help
: Show this message and exit.meshagent voicebot service
--project-id TEXT
--agent-name TEXT
: Name of the agent to call [required]-r, --rule TEXT
: a system rule--rules-file TEXT
-t, --toolkit TEXT
: the name or url of a required toolkit-s, --schema TEXT
: the name or url of a required schema--auto-greet-message TEXT
--auto-greet-prompt TEXT
--host TEXT
--port INTEGER
--path TEXT
: [default: /agent]--help
: Show this message and exit.meshagent mailbot
--help
: Show this message and exit.join
service
meshagent mailbot join
--project-id TEXT
--room TEXT
--api-key-id TEXT
--role TEXT
: [default: agent]--agent-name TEXT
: Name of the agent to call [required]--token-path TEXT
-r, --rule TEXT
: a system rule--rules-file TEXT
-t, --toolkit TEXT
: the name or url of a required toolkit-s, --schema TEXT
: the name or url of a required schema--model TEXT
: Name of the LLM model to use for the chatbot [default: gpt-4o]--local-shell / --no-local-shell
: Enable local shell tool calling [default: no-local-shell]--web-search / --no-web-search
: Enable web search tool calling [default: no-web-search]--help
: Show this message and exit.meshagent mailbot service
--room TEXT
--agent-name TEXT
: Name of the agent to call [required]-r, --rule TEXT
: a system rule--rules-file TEXT
-t, --toolkit TEXT
: the name or url of a required toolkit-s, --schema TEXT
: the name or url of a required schema--model TEXT
: Name of the LLM model to use for the chatbot [default: gpt-4o]--local-shell / --no-local-shell
: Enable local shell tool calling [default: no-local-shell]--host TEXT
--port INTEGER
--path TEXT
: [default: /agent]--help
: Show this message and exit.