Skip to main content

​
meshagent

Usage: 
$ meshagent [OPTIONS] COMMAND [ARGS]...
Options:
  • --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.
Commands:
  • exec: Open an interactive websocket‑based TTY.
  • version: Print the version
  • setup: Perform initial login and project/api key…
  • call
  • auth: Authenticate to meshagent
  • project: Manage or activate your meshagent projects
  • api-key: Manage or activate api-keys for your project
  • session
  • participant-token
  • agents
  • messaging
  • storage: Manage storage for a room
  • developer
  • webhook
  • service: Manage services for your project
  • secret: Manage secrets for your project.
  • queue: Use queues in a room
  • mcp
  • chatbot: Join a chatbot to a room
  • voicebot: Join a voicebot to a room
  • mailbot: Join a mailbot to a room
  • container: Manage containers and images inside a room
  • oauth2: OAuth2 test commands
  • helpers: Join a mailbot to a room
  • room
  • meeting-transcriber: Join a meeting transcriber to a room

​
meshagent exec

Open an interactive websocket‑based TTY. Usage: 
$ meshagent exec [OPTIONS] [COMMAND]...
Arguments:
  • [COMMAND]...
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --name TEXT
  • --image TEXT
  • --tty / --no-tty: [default: no-tty]
  • --room-storage-path TEXT: [default: /data]
  • --help: Show this message and exit.

​
meshagent version

Print the version Usage: 
$ meshagent version [OPTIONS]
Options:
  • --help: Show this message and exit.

​
meshagent setup

Perform initial login and project/api key activation. Usage: 
$ meshagent setup [OPTIONS]
Options:
  • --help: Show this message and exit.

​
meshagent call

Usage: 
$ meshagent call [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • tool
  • agent
  • toolkit
  • schema

​
meshagent call tool

Usage: 
$ meshagent call tool [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --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: ]
  • -p, --permissions TEXT: File path to a token definition, if not specified default agent permissions will be used
  • --key TEXT: an api key to sign the token with
  • --help: Show this message and exit.

​
meshagent call agent

Usage: 
$ meshagent call agent [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --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: ]
  • -p, --permissions TEXT: File path to a token definition, if not specified default agent permissions will be used
  • --key TEXT: an api key to sign the token with
  • --help: Show this message and exit.

​
meshagent call toolkit

Usage: 
$ meshagent call toolkit [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --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: ]
  • -p, --permissions TEXT: File path to a token definition, if not specified default agent permissions will be used
  • --key TEXT: an api key to sign the token with
  • --help: Show this message and exit.

​
meshagent call schema

Usage: 
$ meshagent call schema [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --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: ]
  • -p, --permissions TEXT: File path to a token definition, if not specified default agent permissions will be used
  • --key TEXT: an api key to sign the token with
  • --help: Show this message and exit.

​
meshagent auth

Authenticate to meshagent Usage: 
$ meshagent auth [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • login
  • logout
  • whoami

​
meshagent auth login

Usage: 
$ meshagent auth login [OPTIONS]
Options:
  • --help: Show this message and exit.

​
meshagent auth logout

Usage: 
$ meshagent auth logout [OPTIONS]
Options:
  • --help: Show this message and exit.

​
meshagent auth whoami

Usage: 
$ meshagent auth whoami [OPTIONS]
Options:
  • --help: Show this message and exit.

​
meshagent project

Manage or activate your meshagent projects Usage: 
$ meshagent project [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • create
  • list
  • activate

​
meshagent project create

Usage: 
$ meshagent project create [OPTIONS] NAME
Arguments:
  • NAME: [required]
Options:
  • --help: Show this message and exit.

​
meshagent project list

Usage: 
$ meshagent project list [OPTIONS]
Options:
  • -o, --output TEXT: output format [default: table]
  • --help: Show this message and exit.

​
meshagent project activate

Usage: 
$ meshagent project activate [OPTIONS] [PROJECT_ID]
Arguments:
  • [PROJECT_ID]
Options:
  • -i, --interactive: Interactively select or create a project
  • --help: Show this message and exit.

​
meshagent api-key

Manage or activate api-keys for your project Usage: 
$ meshagent api-key [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • list
  • create
  • activate
  • delete

​
meshagent api-key list

Usage: 
$ meshagent api-key list [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • -o, --output TEXT: output format [default: table]
  • --help: Show this message and exit.

​
meshagent api-key create

Usage: 
$ meshagent api-key create [OPTIONS] NAME
Arguments:
  • NAME: [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --description TEXT: a description for the api key
  • --activate / --no-activate: use this key by default for commands that accept an API key [default: no-activate]
  • --silent / --no-silent: do not print api key [default: no-silent]
  • --help: Show this message and exit.

​
meshagent api-key activate

Usage: 
$ meshagent api-key activate [OPTIONS] KEY
Arguments:
  • KEY: [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --help: Show this message and exit.

​
meshagent api-key delete

Usage: 
$ meshagent api-key delete [OPTIONS] ID
Arguments:
  • ID: [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --help: Show this message and exit.

​
meshagent session

Usage: 
$ meshagent session [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • list
  • show

​
meshagent session list

Usage: 
$ meshagent session list [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --help: Show this message and exit.

​
meshagent session show

Usage: 
$ meshagent session show [OPTIONS] SESSION_ID
Arguments:
  • SESSION_ID: [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --help: Show this message and exit.

​
meshagent participant-token

Usage: 
$ meshagent participant-token [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • generate

​
meshagent participant-token generate

Usage: 
$ meshagent participant-token generate [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • -o, --output TEXT: File path to a file
  • -i, --input TEXT: File path to a token spec [required]
  • --key TEXT: an api key to sign the token with
  • --help: Show this message and exit.

​
meshagent agents

Usage: 
$ meshagent agents [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • 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

Usage: 
$ meshagent agents ask [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --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

Invoke a specific tool from a given toolkit with arguments. Usage: 
$ meshagent agents invoke-tool [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --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

List all agents available in the room. Usage: 
$ meshagent agents list-agents [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --help: Show this message and exit.

​
meshagent agents list-toolkits

List all toolkits (and tools within them) available in the room. Usage: 
$ meshagent agents list-toolkits [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --role TEXT: [default: user]
  • --participant-id TEXT: Optional participant ID
  • --help: Show this message and exit.

​
meshagent messaging

Usage: 
$ meshagent messaging [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • 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

List all messaging-enabled participants in the room. Usage: 
$ meshagent messaging list-participants [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --help: Show this message and exit.

​
meshagent messaging send

Send a direct message to a single participant in the room. Usage: 
$ meshagent messaging send [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --to-participant-id TEXT: Participant ID to send a message to [required]
  • --type TEXT: type of the message to send [required]
  • --data TEXT: JSON message to send [required]
  • --help: Show this message and exit.

​
meshagent messaging broadcast

Broadcast a message to all messaging-enabled participants in the room. Usage: 
$ meshagent messaging broadcast [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --data TEXT: JSON message to broadcast [required]
  • --help: Show this message and exit.

​
meshagent storage

Manage storage for a room Usage: 
$ meshagent storage [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • 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

Check if a file/folder exists in remote storage. Usage: 
$ meshagent storage exists [OPTIONS] PATH
Arguments:
  • PATH: [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --help: Show this message and exit.

​
meshagent storage cp

Usage: 
$ meshagent storage cp [OPTIONS] SOURCE_PATH DEST_PATH
Arguments:
  • SOURCE_PATH: [required]
  • DEST_PATH: [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --help: Show this message and exit.

​
meshagent storage show

Print the contents of a file (local or remote) to the console. Usage: 
$ meshagent storage show [OPTIONS] PATH
Arguments:
  • PATH: [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --encoding TEXT: Text encoding [default: utf-8]
  • --help: Show this message and exit.

​
meshagent storage rm

Remove files (and optionally folders) either locally or in remote storage.
  • Supports wildcards on the source path (for files).
  • Fails if trying to remove a directory/folder without —recursive/-r.
Usage: 
$ meshagent storage rm [OPTIONS] PATH
Arguments:
  • PATH: [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • -r: Remove directories/folders recursively
  • --help: Show this message and exit.

​
meshagent storage ls

List files/folders either locally or in remote storage.
  • Supports wildcards on the path (e.g. *.txt).
  • Use -r for recursive listing.
Usage: 
$ meshagent storage ls [OPTIONS] PATH
Arguments:
  • PATH: Path to list (local or room://…) [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • -r: List subfolders/files recursively
  • --help: Show this message and exit.

​
meshagent developer

Usage: 
$ meshagent developer [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • watch: Watch logs from the developer feed in the…

​
meshagent developer watch

Watch logs from the developer feed in the specified room. Usage: 
$ meshagent developer watch [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --help: Show this message and exit.

​
meshagent webhook

Usage: 
$ meshagent webhook [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • create: Create a new project webhook.
  • list: List all webhooks for the project.
  • delete: Delete a project webhook.

​
meshagent webhook create

Create a new project webhook. Usage: 
$ meshagent webhook create [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --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

List all webhooks for the project. Usage: 
$ meshagent webhook list [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --help: Show this message and exit.

​
meshagent webhook delete

Delete a project webhook. Usage: 
$ meshagent webhook delete [OPTIONS] WEBHOOK_ID
Arguments:
  • WEBHOOK_ID: ID of the webhook to delete [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --help: Show this message and exit.

​
meshagent service

Manage services for your project Usage: 
$ meshagent service [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • create: Create a service attached to the project.
  • update: Create a service attached to the project.
  • run
  • show: Show a services for the project.
  • list: List all services for the project.
  • delete: Delete a service.

​
meshagent service create

Create a service attached to the project. Usage: 
$ meshagent service create [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • -f, --file TEXT: File path to a service definition [required]
  • -r, --room TEXT: The name of a room to create the service for
  • --help: Show this message and exit.

​
meshagent service update

Create a service attached to the project. Usage: 
$ meshagent service update [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --id TEXT
  • -f, --file TEXT: File path to a service definition [required]
  • --create / --no-create: create the service if it does not exist [default: no-create]
  • -r, --room TEXT: The name of a room to update the service for
  • --help: Show this message and exit.

​
meshagent service run

Usage: 
$ meshagent service run [OPTIONS] COMMAND
Arguments:
  • COMMAND: [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • -p, --port INTEGER: a port number to run the agent on (will set MESHAGENT_PORT environment variable when launching the service)
  • --room TEXT: A room name to test the service in (must not be currently running)
  • --key TEXT: an api key to sign the token with
  • --help: Show this message and exit.

​
meshagent service show

Show a services for the project. Usage: 
$ meshagent service show [OPTIONS] SERVICE_ID
Arguments:
  • SERVICE_ID: ID of the service to show [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --help: Show this message and exit.

​
meshagent service list

List all services for the project. Usage: 
$ meshagent service list [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • -o, --output TEXT: output format [default: table]
  • -r, --room TEXT: The name of a room to list the services for
  • --help: Show this message and exit.

​
meshagent service delete

Delete a service. Usage: 
$ meshagent service delete [OPTIONS] SERVICE_ID
Arguments:
  • SERVICE_ID: ID of the service to delete [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • -r, --room TEXT: The name of a room to delete the service for
  • --help: Show this message and exit.

​
meshagent secret

Manage secrets for your project. Usage: 
$ meshagent secret [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • 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

List all secrets in the project (typed as Docker/ACR/GAR or Keys secrets). Usage: 
$ meshagent secret list [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --help: Show this message and exit.

​
meshagent secret delete

Delete a secret. Usage: 
$ meshagent secret delete [OPTIONS] SECRET_ID
Arguments:
  • SECRET_ID: ID of the secret to delete [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --help: Show this message and exit.

​
meshagent secret keys

Create or update environment-based key-value secrets. Usage: 
$ meshagent secret keys [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • create: Create a new ‘keys’ secret (opaque env-vars).
  • update: Update an existing ‘keys’ secret (opaque…

​
meshagent secret keys create

Create a new ‘keys’ secret (opaque env-vars). Usage: 
$ meshagent secret keys create [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --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

Update an existing ‘keys’ secret (opaque env-vars). Usage: 
$ meshagent secret keys update [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --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

Create or update a Docker registry pull secret. Usage: 
$ meshagent secret docker [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • create: Create a new Docker pull secret (generic).
  • update: Update an existing Docker pull secret…

​
meshagent secret docker create

Create a new Docker pull secret (generic). Usage: 
$ meshagent secret docker create [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --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

Update an existing Docker pull secret (generic). Usage: 
$ meshagent secret docker update [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --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

Create or update an Azure Container Registry pull secret. Usage: 
$ meshagent secret acr [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • create: Create a new ACR pull secret (defaults…
  • update: Update an existing ACR pull secret…

​
meshagent secret acr create

Create a new ACR pull secret (defaults email to ‘none@microsoft.com’). Usage: 
$ meshagent secret acr create [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --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

Update an existing ACR pull secret (defaults email to ‘none@microsoft.com’). Usage: 
$ meshagent secret acr update [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --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

Create or update a Google Artifact Registry pull secret. Usage: 
$ meshagent secret gar [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • create: Create a new Google Artifact Registry pull…
  • update: Update an existing Google Artifact…

​
meshagent secret gar create

Create a new Google Artifact Registry pull secret. By default, sets email=‘none@google.com’, username=’_json_key’ Usage: 
$ meshagent secret gar create [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --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

Update an existing Google Artifact Registry pull secret. Usage: 
$ meshagent secret gar update [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --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

Use queues in a room Usage: 
$ meshagent queue [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • send
  • receive

​
meshagent queue send

Usage: 
$ meshagent queue send [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --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

Usage: 
$ meshagent queue receive [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --queue TEXT: Queue name [required]
  • --help: Show this message and exit.

​
meshagent mcp

Usage: 
$ meshagent mcp [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • sse
  • stdio
  • http-proxy
  • sse-proxy
  • stdio-service

​
meshagent mcp sse

Usage: 
$ meshagent mcp sse [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --name TEXT: Participant name [default: cli]
  • --role TEXT: [default: tool]
  • --url TEXT: [required]
  • --toolkit-name TEXT
  • --key TEXT: an api key to sign the token with
  • --help: Show this message and exit.

​
meshagent mcp stdio

Usage: 
$ meshagent mcp stdio [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --name TEXT: Participant name [default: cli]
  • --role TEXT: [default: tool]
  • --command TEXT: [required]
  • --toolkit-name TEXT
  • -e, --env TEXT: KEY=VALUE
  • --key TEXT: an api key to sign the token with
  • --help: Show this message and exit.

​
meshagent mcp http-proxy

Usage: 
$ meshagent mcp http-proxy [OPTIONS]
Options:
  • --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

Usage: 
$ meshagent mcp sse-proxy [OPTIONS]
Options:
  • --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

Usage: 
$ meshagent mcp stdio-service [OPTIONS]
Options:
  • --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

Join a chatbot to a room Usage: 
$ meshagent chatbot [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • join
  • service

​
meshagent chatbot join

Usage: 
$ meshagent chatbot join [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --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
  • --model TEXT: Name of the LLM model to use for the chatbot [default: gpt-5]
  • --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]
  • --mcp / --no-mcp: Enable mcp tool calling [default: no-mcp]
  • --storage / --no-storage: Enable storage toolkit [default: no-storage]
  • --key TEXT: an api key to sign the token with
  • --help: Show this message and exit.

​
meshagent chatbot service

Usage: 
$ meshagent chatbot service [OPTIONS]
Options:
  • --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-5]
  • --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]
  • --mcp / --no-mcp: Enable mcp tool calling [default: no-mcp]
  • --storage / --no-storage: Enable storage toolkit [default: no-storage]
  • --host TEXT
  • --port INTEGER
  • --path TEXT: [default: /agent]
  • --help: Show this message and exit.

​
meshagent voicebot

Join a voicebot to a room Usage: 
$ meshagent voicebot [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • join
  • service

​
meshagent voicebot join

Usage: 
$ meshagent voicebot join [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --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
  • --key TEXT: an api key to sign the token with
  • --help: Show this message and exit.

​
meshagent voicebot service

Usage: 
$ meshagent voicebot service [OPTIONS]
Options:
  • --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

Join a mailbot to a room Usage: 
$ meshagent mailbot [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • join
  • service

​
meshagent mailbot join

Usage: 
$ meshagent mailbot join [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --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
  • --model TEXT: Name of the LLM model to use for the chatbot [default: gpt-5]
  • --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]
  • --key TEXT: an api key to sign the token with
  • --queue TEXT: the name of the mail queue [required]
  • --email-address TEXT: the email address of the agent [required]
  • --help: Show this message and exit.

​
meshagent mailbot service

Usage: 
$ meshagent mailbot service [OPTIONS]
Options:
  • --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-5]
  • --local-shell / --no-local-shell: Enable local shell tool calling [default: no-local-shell]
  • --host TEXT
  • --port INTEGER
  • --path TEXT: [default: /agent]
  • --queue TEXT: the name of the mail queue [required]
  • --email-address TEXT: the email address of the agent [required]
  • --help: Show this message and exit.

​
meshagent container

Manage containers and images inside a room Usage: 
$ meshagent container [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • ps
  • stop
  • logs
  • run
  • images: Image operations

​
meshagent container ps

Usage: 
$ meshagent container ps [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --output TEXT: json | table [default: json]
  • --help: Show this message and exit.

​
meshagent container stop

Usage: 
$ meshagent container stop [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --id TEXT: Container ID [required]
  • --help: Show this message and exit.

​
meshagent container logs

Usage: 
$ meshagent container logs [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --id TEXT: Container ID [required]
  • --follow / --no-follow: [default: no-follow]
  • --help: Show this message and exit.

​
meshagent container run

Usage: 
$ meshagent container run [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --image TEXT: Image to run [required]
  • --command TEXT
  • -e, --env TEXT: KEY=VALUE
  • -p, --port TEXT: CONTAINER:HOST
  • --var TEXT: Template variable KEY=VALUE (optional)
  • --cred TEXT: Docker creds (username,password) or (registry,username,password)
  • --mount-path TEXT
  • --mount-subpath TEXT
  • --participant-name TEXT
  • --role TEXT: [default: user]
  • --container-name TEXT
  • --help: Show this message and exit.

​
meshagent container images

Image operations Usage: 
$ meshagent container images [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • list
  • delete
  • pull

​
meshagent container images list

Usage: 
$ meshagent container images list [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --help: Show this message and exit.

​
meshagent container images delete

Usage: 
$ meshagent container images delete [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --image TEXT: Image ref/tag to delete [required]
  • --help: Show this message and exit.

​
meshagent container images pull

Usage: 
$ meshagent container images pull [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --tag TEXT: Image tag/ref to pull [required]
  • --cred TEXT: Docker creds (username,password) or (registry,username,password)
  • --help: Show this message and exit.

​
meshagent oauth2

OAuth2 test commands Usage: 
$ meshagent oauth2 [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • request: Run an OAuth2 request test between two…
  • get: Run an OAuth2 request test between two…
  • list: list secrets
  • delete: delete a secret

​
meshagent oauth2 request

Run an OAuth2 request test between two participants in the same room. One will act as the consumer, the other as the provider. Usage: 
$ meshagent oauth2 request [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --from-participant-id TEXT: [required]
  • --client-id TEXT: [required]
  • --authorization-endpoint TEXT: [required]
  • --token-endpoint TEXT: [required]
  • --scopes TEXT
  • --client-secret TEXT: [required]
  • --redirect-uri TEXT: [required]
  • --pkce / --no-pkce: [default: pkce]
  • --help: Show this message and exit.

​
meshagent oauth2 get

Run an OAuth2 request test between two participants in the same room. One will act as the consumer, the other as the provider. Usage: 
$ meshagent oauth2 get [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --delegated-to TEXT: [required]
  • --client-id TEXT: [required]
  • --authorization-endpoint TEXT: [required]
  • --token-endpoint TEXT: [required]
  • --scopes TEXT
  • --client-secret TEXT: [required]
  • --redirect-uri TEXT: [required]
  • --pkce / --no-pkce: [default: pkce]
  • --help: Show this message and exit.

​
meshagent oauth2 list

list secrets Usage: 
$ meshagent oauth2 list [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --help: Show this message and exit.

​
meshagent oauth2 delete

delete a secret Usage: 
$ meshagent oauth2 delete [OPTIONS] ID
Arguments:
  • ID: [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --delegated-to TEXT
  • --help: Show this message and exit.

​
meshagent helpers

Join a mailbot to a room Usage: 
$ meshagent helpers [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • service

​
meshagent helpers service

Usage: 
$ meshagent helpers service [OPTIONS]
Options:
  • --help: Show this message and exit.

​
meshagent room

Usage: 
$ meshagent room [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • create: Create a room in the project.
  • delete: Delete a room by ID (or by name if —name…
  • update: Update a room’s name (ID is preferred;…
  • list: List rooms in the project.
  • get: Get a single room by name (handy for…

​
meshagent room create

Create a room in the project. Usage: 
$ meshagent room create [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --name TEXT: Room name [required]
  • --if-not-exists / --no-if-not-exists: Do not error if the room already exists [default: no-if-not-exists]
  • --metadata TEXT: Optional JSON object for room metadata
  • --help: Show this message and exit.

​
meshagent room delete

Delete a room by ID (or by name if —name is supplied). Usage: 
$ meshagent room delete [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --id TEXT: Room ID (preferred)
  • --name TEXT
  • --help: Show this message and exit.

​
meshagent room update

Update a room’s name (ID is preferred; name will be resolved to ID if needed). Usage: 
$ meshagent room update [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --id TEXT: Room ID (preferred)
  • --name TEXT
  • --new-name TEXT: New room name [required]
  • --help: Show this message and exit.

​
meshagent room list

List rooms in the project. Usage: 
$ meshagent room list [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --limit INTEGER RANGE: Max rooms to return [default: 50; 1<=x<=500]
  • --offset INTEGER RANGE: Offset for pagination [default: 0; x>=0]
  • --order-by TEXT: Order by column (e.g. “room_name”, “created_at”) [default: room_name]
  • --help: Show this message and exit.

​
meshagent room get

Get a single room by name (handy for resolving the ID). Usage: 
$ meshagent room get [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --name TEXT
  • --help: Show this message and exit.

​
meshagent meeting-transcriber

Join a meeting transcriber to a room Usage: 
$ meshagent meeting-transcriber [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • join
  • service

​
meshagent meeting-transcriber join

Usage: 
$ meshagent meeting-transcriber join [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name [required]
  • --agent-name TEXT: Name of the agent [required]
  • --key TEXT: an api key to sign the token with
  • --help: Show this message and exit.

​
meshagent meeting-transcriber service

Usage: 
$ meshagent meeting-transcriber service [OPTIONS]
Options:
  • --agent-name TEXT: Name of the agent [required]
  • --host TEXT
  • --port INTEGER
  • --path TEXT: [default: /agent]
  • --help: Show this message and exit.