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:
  • version: Print the version
  • setup: Perform initial login and project/api key…
  • call: Trigger agent/tool calls via URL
  • auth: Authenticate to meshagent
  • project: Manage or activate your meshagent projects
  • api-key: Manage or activate api-keys for your project
  • session: Inspect recent sessions and events
  • token: Generate participant tokens (JWTs)
  • webhook: Manage project webhooks
  • service: Manage services for your project
  • mcp: Bridge MCP servers into MeshAgent rooms
  • secrets: Manage secrets for your project.
  • helpers: Developer helper services
  • rooms: Create, list, and manage rooms in a project
  • mailbox: Manage mailboxes for your project
  • meeting-transcriber: Join a meeting transcriber to a room
  • port: Port forwarding into room containers
  • multi: Connect agents and tools to a room
  • voicebot: Join a voicebot to a room
  • chatbot: Join a chatbot to a room
  • mailbot: Join a mailbot to a room
  • task-runner: Join a taskrunner to a room
  • worker: Join a worker agent to a room
  • room: Operate within a room

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

Trigger agent/tool calls via URL Usage:
$ meshagent call [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • tool: Send a call request to a tool webhook URL
  • agent: Send a call request to an agent webhook URL
  • toolkit: Send a call request to a toolkit webhook URL
  • schema: Send a call request to a schema webhook URL

meshagent call tool

Send a call request to a tool webhook URL Usage:
$ meshagent call tool [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --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

Send a call request to an agent webhook URL Usage:
$ meshagent call agent [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --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

Send a call request to a toolkit webhook URL Usage:
$ meshagent call toolkit [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --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

Send a call request to a schema webhook URL Usage:
$ meshagent call schema [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --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. [required]
  • -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. [required]
  • --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. [required]
  • --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. [required]
  • --help: Show this message and exit.

meshagent session

Inspect recent sessions and events Usage:
$ meshagent session [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • list: List recent sessions
  • show: Show events for a session

meshagent session list

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

meshagent session show

Show events for a session 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. [required]
  • --help: Show this message and exit.

meshagent token

Generate participant tokens (JWTs) Usage:
$ meshagent token [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • generate: Generate a participant token (JWT) from a…

meshagent token generate

Generate a participant token (JWT) from a spec Usage:
$ meshagent token generate [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • -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 webhook

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

meshagent webhook create

Create a webhook Usage:
$ meshagent webhook create [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --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 webhooks Usage:
$ meshagent webhook list [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --help: Show this message and exit.

meshagent webhook delete

Delete a 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. [required]
  • --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.
  • validate: Validate a service spec from a YAML file.
  • create-template: Create a service from a ServiceTemplate spec.
  • update-template: Update a service using a ServiceTemplate…
  • validate-template: Validate a service template from a YAML file.
  • 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. [required]
  • -f, --file TEXT: File path to a service definition
  • --url TEXT: URL to a service definition
  • --room TEXT: Room name
  • --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. [required]
  • --id TEXT
  • -f, --file TEXT: File path to a service definition
  • --url TEXT: URL to a service definition
  • --create / --no-create: create the service if it does not exist [default: no-create]
  • --room TEXT: Room name
  • --help: Show this message and exit.

meshagent service validate

Validate a service spec from a YAML file. Usage:
$ meshagent service validate [OPTIONS]
Options:
  • -f, --file TEXT: File path to a service definition [required]
  • --help: Show this message and exit.

meshagent service create-template

Create a service from a ServiceTemplate spec. Usage:
$ meshagent service create-template [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • -f, --file TEXT: File path to a service template
  • --url TEXT: URL to a service template
  • --values-file TEXT: File path to template values
  • -v, --value TEXT: Template value override (key=value)
  • --room TEXT: Room name
  • --help: Show this message and exit.

meshagent service update-template

Update a service using a ServiceTemplate spec. Usage:
$ meshagent service update-template [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --id TEXT
  • -f, --file TEXT: File path to a service template
  • --url TEXT: URL to a service template
  • --values-file TEXT: File path to template values
  • -v, --value TEXT: Template value override (key=value)
  • --create / --no-create: create the service if it does not exist [default: no-create]
  • --room TEXT: Room name
  • --help: Show this message and exit.

meshagent service validate-template

Validate a service template from a YAML file. Usage:
$ meshagent service validate-template [OPTIONS]
Options:
  • -f, --file TEXT: File path to a service template [required]
  • --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. [required]
  • -p, --port INTEGER: a port number to run the agent on (will set MESHAGENT_PORT environment variable when launching the service)
  • --room TEXT: Room name
  • --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. [required]
  • --room TEXT: Room name
  • --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. [required]
  • -o, --output TEXT: output format [default: table]
  • --room TEXT: Room name
  • --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. [required]
  • --room TEXT: Room name
  • --help: Show this message and exit.

meshagent mcp

Bridge MCP servers into MeshAgent rooms Usage:
$ meshagent mcp [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • sse: Connect an MCP server over SSE and…
  • http: Connect an MCP server over streamable HTTP…
  • stdio: Run an MCP server over stdio and register…
  • http-proxy: Expose a stdio MCP server over streamable…
  • sse-proxy: Expose a stdio MCP server over SSE
  • stdio-service: Run a stdio MCP server as an HTTP service

meshagent mcp sse

Connect an MCP server over SSE and register it as a toolkit Usage:
$ meshagent mcp sse [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --name TEXT: Participant name [default: cli]
  • --role TEXT: [default: tool]
  • --url TEXT: SSE URL for the MCP server [required]
  • -H, --header TEXT: Request header (KEY=VALUE). Repeat for multiple headers
  • --header-secret TEXT: Header from secret (HEADER=SECRET_ID[:KEY])
  • --toolkit-name TEXT: Toolkit name to register in the room (default: mcp)
  • --key TEXT: an api key to sign the token with
  • --help: Show this message and exit.

meshagent mcp http

Connect an MCP server over streamable HTTP and register it as a toolkit Usage:
$ meshagent mcp http [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --name TEXT: Participant name [default: cli]
  • --role TEXT: [default: tool]
  • --url TEXT: Streamable HTTP URL for the MCP server [required]
  • -H, --header TEXT: Request header (KEY=VALUE). Repeat for multiple headers
  • --header-secret TEXT: Header from secret (HEADER=SECRET_ID[:KEY])
  • --toolkit-name TEXT: Toolkit name to register in the room (default: mcp)
  • --key TEXT: an api key to sign the token with
  • --help: Show this message and exit.

meshagent mcp stdio

Run an MCP server over stdio and register it as a toolkit Usage:
$ meshagent mcp stdio [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --name TEXT: Participant name [default: cli]
  • --role TEXT: [default: tool]
  • --command TEXT: Command to start an MCP server over stdio (quoted string) [required]
  • --toolkit-name TEXT: Toolkit name to register in the room (default: mcp)
  • -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

Expose a stdio MCP server over streamable HTTP Usage:
$ meshagent mcp http-proxy [OPTIONS]
Options:
  • --command TEXT: Command to start the MCP server (stdio transport) [required]
  • --host TEXT: Host to bind the proxy server on
  • --port INTEGER: Port to bind the proxy server on
  • --path TEXT: HTTP path to mount the proxy server at
  • --name TEXT: Display name for the proxy server
  • -e, --env TEXT: KEY=VALUE
  • --help: Show this message and exit.

meshagent mcp sse-proxy

Expose a stdio MCP server over SSE Usage:
$ meshagent mcp sse-proxy [OPTIONS]
Options:
  • --command TEXT: Command to start the MCP server (stdio transport) [required]
  • --host TEXT: Host to bind the proxy server on
  • --port INTEGER: Port to bind the proxy server on
  • --path TEXT: SSE path to mount the proxy at
  • --name TEXT: Display name for the proxy server
  • -e, --env TEXT: KEY=VALUE
  • --help: Show this message and exit.

meshagent mcp stdio-service

Run a stdio MCP server as an HTTP service Usage:
$ meshagent mcp stdio-service [OPTIONS]
Options:
  • --command TEXT: Command to start an MCP server over stdio (quoted string) [required]
  • --host TEXT: Host to bind the service on
  • --port INTEGER: Port to bind the service on
  • --webhook-secret TEXT: Optional webhook secret for authenticating requests
  • --path TEXT: HTTP path to mount the service at
  • --toolkit-name TEXT: Toolkit name to expose (default: mcp)
  • -e, --env TEXT: KEY=VALUE
  • --help: Show this message and exit.

meshagent secrets

Manage secrets for your project. Usage:
$ meshagent secrets [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 secrets list

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

meshagent secrets delete

Delete a secret. Usage:
$ meshagent secrets 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. [required]
  • --help: Show this message and exit.

meshagent secrets keys

Create or update environment-based key-value secrets. Usage:
$ meshagent secrets 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 secrets keys create

Create a new ‘keys’ secret (opaque env-vars). Usage:
$ meshagent secrets keys create [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --name TEXT: Secret name [required]
  • --data TEXT: Format: key=value key2=value (space-separated) [required]
  • --help: Show this message and exit.

meshagent secrets keys update

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

Create or update a Docker registry pull secret. Usage:
$ meshagent secrets 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 secrets docker create

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

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

Create or update an Azure Container Registry pull secret. Usage:
$ meshagent secrets 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 secrets acr create

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

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

Create or update a Google Artifact Registry pull secret. Usage:
$ meshagent secrets 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 secrets gar create

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

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

Developer helper services Usage:
$ meshagent helpers [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • service: Run local helper HTTP services

meshagent helpers service

Run local helper HTTP services Usage:
$ meshagent helpers service [OPTIONS]
Options:
  • --help: Show this message and exit.

meshagent rooms

Create, list, and manage rooms in a project Usage:
$ meshagent rooms [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 rooms create

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

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

meshagent rooms update

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

meshagent rooms list

List rooms in the project. Usage:
$ meshagent rooms list [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --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 rooms get

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

meshagent mailbox

Manage mailboxes for your project Usage:
$ meshagent mailbox [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • create: Create a mailbox attached to the project.
  • update: Update a mailbox routing configuration.
  • show: Show mailbox details.
  • list: List mailboxes for the project.
  • delete: Delete a mailbox.

meshagent mailbox create

Create a mailbox attached to the project. Usage:
$ meshagent mailbox create [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • -a, --address TEXT: Mailbox email address (unique per project) [required]
  • --room TEXT: Room name
  • -q, --queue TEXT: Queue name to deliver inbound messages to [required]
  • --public: Queue name to deliver inbound messages to
  • --help: Show this message and exit.

meshagent mailbox update

Update a mailbox routing configuration. Usage:
$ meshagent mailbox update [OPTIONS] ADDRESS
Arguments:
  • ADDRESS: Mailbox email address to update [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • -r, --room TEXT: Room name to route inbound mail into
  • -q, --queue TEXT: Queue name to deliver inbound messages to
  • --public: Queue name to deliver inbound messages to
  • --help: Show this message and exit.

meshagent mailbox show

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

meshagent mailbox list

List mailboxes for the project. Usage:
$ meshagent mailbox list [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name
  • -o, --output TEXT: output format [default: table]
  • --help: Show this message and exit.

meshagent mailbox delete

Delete a mailbox. Usage:
$ meshagent mailbox delete [OPTIONS] ADDRESS
Arguments:
  • ADDRESS: Mailbox address to delete [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --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. [required]
  • --room TEXT: Room name [required]
  • --agent-name TEXT: Name of the agent
  • --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: Host to bind the service on
  • --port INTEGER: Port to bind the service on
  • --path TEXT: HTTP path to mount the service at [default: /agent]
  • --help: Show this message and exit.

meshagent port

Port forwarding into room containers Usage:
$ meshagent port [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • forward: Forward a container port to localhost

meshagent port forward

Forward a container port to localhost Usage:
$ meshagent port forward [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • -r, --room TEXT: Room name containing the target container [required]
  • -c, --container-id TEXT: Container ID to port-forward into [required]
  • -p, --port TEXT: Port mapping in the form LOCAL:REMOTE [required]
  • --help: Show this message and exit.

meshagent multi

Connect agents and tools to a room Usage:
$ meshagent multi [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • spec
  • deploy
  • service
  • join

meshagent multi spec

Usage:
$ meshagent multi spec [OPTIONS]
Options:
  • -c TEXT: a list of sub commands to run, seperated by semicolons
available sub commands: chatbot …; mailbot …; worker …; voicebot …; python path-to-python-file.py —name=NameOfModule; chatbot, worker, and mailbot command arguments mirror those of the respective meshagent chatbot service, meshagent mailbot service, meshagent voicebot service, and meshagent worker service commands. [required]
  • --service-name TEXT: service name [required]
  • --service-description TEXT: service description
  • --service-title TEXT: a display name for the service
  • --help: Show this message and exit.

meshagent multi deploy

Usage:
$ meshagent multi deploy [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • -c TEXT: a list of sub commands to run, seperated by semicolons
available sub commands: chatbot …; mailbot …; worker …; voicebot …; python path-to-python-file.py —name=NameOfModule; chatbot, worker, and mailbot command arguments mirror those of the respective meshagent chatbot service, meshagent mailbot service, meshagent voicebot service, and meshagent worker service commands. [required]
  • --service-name TEXT: service name [required]
  • --service-description TEXT: service description
  • --service-title TEXT: a display name for the service
  • --room TEXT: The name of a room to create the service for
  • --help: Show this message and exit.

meshagent multi service

Usage:
$ meshagent multi service [OPTIONS]
Options:
  • --host TEXT: Host to bind the service on
  • --port INTEGER: Port to bind the service on
  • -c TEXT: a list of sub commands to run, seperated by semicolons
available sub commands: chatbot …; mailbot …; worker …; voicebot …; python path-to-python-file.py —name=NameOfModule; chatbot, worker, and mailbot command arguments mirror those of the respective meshagent chatbot service, meshagent mailbot service, meshagent voicebot service, and meshagent worker service commands.
  • --help: Show this message and exit.

meshagent multi join

Usage:
$ meshagent multi join [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • -c TEXT: a list of sub commands to run, seperated by semicolons
available sub commands: chatbot …; mailbot …; worker …; voicebot …; python path-to-python-file.py —name=NameOfModule; chatbot, worker, and mailbot command arguments mirror those of the respective meshagent chatbot service, meshagent mailbot service, meshagent voicebot service, and meshagent worker service commands.
  • -p, --port INTEGER: a port number to run the agent on (will set MESHAGENT_PORT environment variable when launching the service)
  • --room TEXT: Room name [required]
  • --key TEXT: an api key to sign the token with
  • --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
  • spec
  • deploy

meshagent voicebot join

Usage:
$ meshagent voicebot join [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --agent-name TEXT: Name of the agent to call
  • -r, --rule TEXT: a system rule
  • --rules-file TEXT
  • -rt, --require-toolkit TEXT: the name or url of a required toolkit
  • -rs, --require-schema TEXT: the name or url of a required schema
  • --auto-greet-message TEXT: Message to send automatically when the bot joins
  • --auto-greet-prompt TEXT: Prompt to generate an auto-greet message
  • --key TEXT: an api key to sign the token with
  • -rr, --room-rules TEXT: a path to a rules file within the room that can be used to customize the agent’s behavior
  • --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
  • -rt, --require-toolkit TEXT: the name or url of a required toolkit
  • -rs, --require-schema TEXT: the name or url of a required schema
  • --auto-greet-message TEXT: Message to send automatically when the bot joins
  • --auto-greet-prompt TEXT: Prompt to generate an auto-greet message
  • --host TEXT: Host to bind the service on
  • --port INTEGER: Port to bind the service on
  • --path TEXT: HTTP path to mount the service at
  • -rr, --room-rules TEXT: a path to a rules file within the room that can be used to customize the agent’s behavior
  • --help: Show this message and exit.

meshagent voicebot spec

Usage:
$ meshagent voicebot spec [OPTIONS]
Options:
  • --service-name TEXT: service name [required]
  • --service-description TEXT: service description
  • --service-title TEXT: a display name for the service
  • --agent-name TEXT: Name of the agent to call [required]
  • -r, --rule TEXT: a system rule
  • --rules-file TEXT
  • -rt, --require-toolkit TEXT: the name or url of a required toolkit
  • -rs, --require-schema TEXT: the name or url of a required schema
  • --auto-greet-message TEXT: Message to send automatically when the bot joins
  • --auto-greet-prompt TEXT: Prompt to generate an auto-greet message
  • --host TEXT: Host to bind the service on
  • --port INTEGER: Port to bind the service on
  • --path TEXT: HTTP path to mount the service at
  • -rr, --room-rules TEXT: a path to a rules file within the room that can be used to customize the agent’s behavior
  • --help: Show this message and exit.

meshagent voicebot deploy

Usage:
$ meshagent voicebot deploy [OPTIONS]
Options:
  • --service-name TEXT: service name [required]
  • --service-description TEXT: service description
  • --service-title TEXT: a display name for the service
  • --agent-name TEXT: Name of the agent to call [required]
  • -r, --rule TEXT: a system rule
  • --rules-file TEXT
  • -rt, --require-toolkit TEXT: the name or url of a required toolkit
  • -rs, --require-schema TEXT: the name or url of a required schema
  • --auto-greet-message TEXT: Message to send automatically when the bot joins
  • --auto-greet-prompt TEXT: Prompt to generate an auto-greet message
  • --host TEXT: Host to bind the service on
  • --port INTEGER: Port to bind the service on
  • --path TEXT: HTTP path to mount the service at
  • -rr, --room-rules TEXT: a path to a rules file within the room that can be used to customize the agent’s behavior
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: The name of a room to create the service for
  • --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
  • spec
  • deploy
  • run
  • use

meshagent chatbot join

Usage:
$ meshagent chatbot join [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --role TEXT: [default: agent]
  • --agent-name TEXT: Name of the agent to call
  • -r, --rule TEXT: a system rule
  • -rr, --room-rules TEXT: a path to a rules file within the room that can be used to customize the agent’s behavior
  • --rules-file TEXT
  • -rt, --require-toolkit TEXT: the name or url of a required toolkit
  • -rs, --require-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.2]
  • --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]
  • --shell / --no-shell: Enable function shell tool calling [default: no-shell]
  • --apply-patch / --no-apply-patch: Enable apply patch tool [default: no-apply-patch]
  • --web-search / --no-web-search: Enable web search tool calling [default: no-web-search]
  • --web-fetch / --no-web-fetch: Enable web fetch tool calling [default: no-web-fetch]
  • --script-tool / --no-script-tool: Enable script tool calling [default: no-script-tool]
  • --discover-script-tools / --no-discover-script-tools: Automatically add script tools from the room [default: no-discover-script-tools]
  • --mcp / --no-mcp: Enable mcp tool calling [default: no-mcp]
  • --storage / --no-storage: Enable storage toolkit [default: no-storage]
  • --storage-tool-local-path TEXT: Mount local path as <source>:<mount>[:ro|rw]
  • --storage-tool-room-path TEXT: Mount room path as <source>:<mount>[:ro|rw]
  • --require-image-generation TEXT: Name of an image gen model
  • --require-local-shell / --no-require-local-shell: Enable local shell tool calling [default: no-require-local-shell]
  • --require-shell / --no-require-shell: Enable function shell tool calling [default: no-require-shell]
  • --require-apply-patch / --no-require-apply-patch: Enable apply patch tool calling [default: no-require-apply-patch]
  • --require-web-search / --no-require-web-search: Enable web search tool calling [default: no-require-web-search]
  • --require-web-fetch / --no-require-web-fetch: Enable web fetch tool calling [default: no-require-web-fetch]
  • --require-mcp / --no-require-mcp: Enable mcp tool calling [default: no-require-mcp]
  • --require-storage / --no-require-storage: Enable storage toolkit [default: no-require-storage]
  • --database-namespace TEXT: Use a specific database namespace
  • --require-table-read TEXT: Enable table read tools for a specific table
  • --require-table-write TEXT: Enable table write tools for a specific table
  • --require-read-only-storage / --no-require-read-only-storage: Enable read only storage toolkit [default: no-require-read-only-storage]
  • --require-time / --no-require-time: Enable time/datetime tools [default: require-time]
  • --require-uuid / --no-require-uuid: Enable UUID generation tools [default: no-require-uuid]
  • --require-document-authoring / --no-require-document-authoring: Enable MeshDocument authoring [default: no-require-document-authoring]
  • --require-discovery / --no-require-discovery: Enable discovery of agents and tools [default: no-require-discovery]
  • --working-directory TEXT: The default working directory for shell commands
  • --key TEXT: an api key to sign the token with
  • --llm-participant TEXT: Delegate LLM interactions to a remote participant
  • --always-reply / --no-always-reply: Always reply
  • --skill-dir TEXT: an agent skills directory
  • --shell-image TEXT: an image tag to use to run shell commands in
  • --delegate-shell-token / --no-delegate-shell-token: log all requests to the llm [default: no-delegate-shell-token]
  • --log-llm-requests / --no-log-llm-requests: log all requests to the llm [default: no-log-llm-requests]
  • --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
  • -rr, --room-rules TEXT: a path to a rules file within the room that can be used to customize the agent’s behavior
  • -rt, --require-toolkit TEXT: the name or url of a required toolkit
  • -rs, --require-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.2]
  • --image-generation TEXT: Name of an image gen model
  • --local-shell / --no-local-shell: Enable local shell tool calling [default: no-local-shell]
  • --shell / --no-shell: Enable function shell tool calling [default: no-shell]
  • --apply-patch / --no-apply-patch: Enable apply patch tool [default: no-apply-patch]
  • --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]
  • --web-fetch / --no-web-fetch: Enable web fetch tool calling [default: no-web-fetch]
  • --script-tool / --no-script-tool: Enable script tool calling [default: no-script-tool]
  • --discover-script-tools / --no-discover-script-tools: Automatically add script tools from the room [default: no-discover-script-tools]
  • --mcp / --no-mcp: Enable mcp tool calling [default: no-mcp]
  • --storage / --no-storage: Enable storage toolkit [default: no-storage]
  • --storage-tool-local-path TEXT: Mount local path as <source>:<mount>[:ro|rw]
  • --storage-tool-room-path TEXT: Mount room path as <source>:<mount>[:ro|rw]
  • --require-image-generation TEXT: Name of an image gen model
  • --require-local-shell / --no-require-local-shell: Enable local shell tool calling [default: no-require-local-shell]
  • --require-shell / --no-require-shell: Enable function shell tool calling [default: no-require-shell]
  • --require-apply-patch / --no-require-apply-patch: Enable apply patch tool [default: no-require-apply-patch]
  • --require-web-search / --no-require-web-search: Enable web search tool calling [default: no-require-web-search]
  • --require-web-fetch / --no-require-web-fetch: Enable web fetch tool calling [default: no-require-web-fetch]
  • --require-mcp / --no-require-mcp: Enable mcp tool calling [default: no-require-mcp]
  • --require-storage / --no-require-storage: Enable storage toolkit [default: no-require-storage]
  • --database-namespace TEXT: Use a specific database namespace
  • --require-table-read TEXT: Enable table read tools for a specific table
  • --require-table-write TEXT: Enable table write tools for a specific table
  • --require-read-only-storage / --no-require-read-only-storage: Enable read only storage toolkit [default: no-require-read-only-storage]
  • --require-time / --no-require-time: Enable time/datetime tools [default: require-time]
  • --require-uuid / --no-require-uuid: Enable UUID generation tools [default: no-require-uuid]
  • --working-directory TEXT: The default working directory for shell commands
  • --require-document-authoring / --no-require-document-authoring: Enable document authoring [default: no-require-document-authoring]
  • --require-discovery / --no-require-discovery: Enable discovery of agents and tools [default: no-require-discovery]
  • --llm-participant TEXT: Delegate LLM interactions to a remote participant
  • --host TEXT: Host to bind the service on
  • --port INTEGER: Port to bind the service on
  • --path TEXT: HTTP path to mount the service at
  • --always-reply / --no-always-reply: Always reply
  • --skill-dir TEXT: an agent skills directory
  • --shell-image TEXT: an image tag to use to run shell commands in
  • --delegate-shell-token / --no-delegate-shell-token: log all requests to the llm [default: no-delegate-shell-token]
  • --log-llm-requests / --no-log-llm-requests: log all requests to the llm [default: no-log-llm-requests]
  • --help: Show this message and exit.

meshagent chatbot spec

Usage:
$ meshagent chatbot spec [OPTIONS]
Options:
  • --service-name TEXT: service name [required]
  • --service-description TEXT: service description
  • --service-title TEXT: a display name for the service
  • --agent-name TEXT: Name of the agent to call [required]
  • -r, --rule TEXT: a system rule
  • --rules-file TEXT
  • -rr, --room-rules TEXT: a path to a rules file within the room that can be used to customize the agent’s behavior
  • -rt, --require-toolkit TEXT: the name or url of a required toolkit
  • -rs, --require-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.2]
  • --image-generation TEXT: Name of an image gen model
  • --local-shell / --no-local-shell: Enable local shell tool calling [default: no-local-shell]
  • --shell / --no-shell: Enable function shell tool calling [default: no-shell]
  • --apply-patch / --no-apply-patch: Enable apply patch tool [default: no-apply-patch]
  • --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]
  • --web-fetch / --no-web-fetch: Enable web fetch tool calling [default: no-web-fetch]
  • --script-tool / --no-script-tool: Enable script tool calling [default: no-script-tool]
  • --discover-script-tools / --no-discover-script-tools: Automatically add script tools from the room [default: no-discover-script-tools]
  • --mcp / --no-mcp: Enable mcp tool calling [default: no-mcp]
  • --storage / --no-storage: Enable storage toolkit [default: no-storage]
  • --storage-tool-local-path TEXT: Mount local path as <source>:<mount>[:ro|rw]
  • --storage-tool-room-path TEXT: Mount room path as <source>:<mount>[:ro|rw]
  • --require-image-generation TEXT: Name of an image gen model
  • --require-local-shell / --no-require-local-shell: Enable local shell tool calling [default: no-require-local-shell]
  • --require-shell / --no-require-shell: Enable function shell tool calling [default: no-require-shell]
  • --require-apply-patch / --no-require-apply-patch: Enable apply patch tool [default: no-require-apply-patch]
  • --require-web-search / --no-require-web-search: Enable web search tool calling [default: no-require-web-search]
  • --require-web-fetch / --no-require-web-fetch: Enable web fetch tool calling [default: no-require-web-fetch]
  • --require-mcp / --no-require-mcp: Enable mcp tool calling [default: no-require-mcp]
  • --require-storage / --no-require-storage: Enable storage toolkit [default: no-require-storage]
  • --database-namespace TEXT: Use a specific database namespace
  • --require-table-read TEXT: Enable table read tools for a specific table
  • --require-table-write TEXT: Enable table write tools for a specific table
  • --require-read-only-storage / --no-require-read-only-storage: Enable read only storage toolkit [default: no-require-read-only-storage]
  • --require-time / --no-require-time: Enable time/datetime tools [default: require-time]
  • --require-uuid / --no-require-uuid: Enable UUID generation tools [default: no-require-uuid]
  • --working-directory TEXT: The default working directory for shell commands
  • --require-document-authoring / --no-require-document-authoring: Enable document authoring [default: no-require-document-authoring]
  • --require-discovery / --no-require-discovery: Enable discovery of agents and tools [default: no-require-discovery]
  • --llm-participant TEXT: Delegate LLM interactions to a remote participant
  • --host TEXT: Host to bind the service on
  • --port INTEGER: Port to bind the service on
  • --path TEXT: HTTP path to mount the service at
  • --always-reply / --no-always-reply: Always reply
  • --skill-dir TEXT: an agent skills directory
  • --shell-image TEXT: an image tag to use to run shell commands in
  • --delegate-shell-token / --no-delegate-shell-token: log all requests to the llm [default: no-delegate-shell-token]
  • --log-llm-requests / --no-log-llm-requests: log all requests to the llm [default: no-log-llm-requests]
  • --help: Show this message and exit.

meshagent chatbot deploy

Usage:
$ meshagent chatbot deploy [OPTIONS]
Options:
  • --service-name TEXT: service name [required]
  • --service-description TEXT: service description
  • --service-title TEXT: a display name for the service
  • --agent-name TEXT: Name of the agent to call [required]
  • -r, --rule TEXT: a system rule
  • --rules-file TEXT
  • -rr, --room-rules TEXT: a path to a rules file within the room that can be used to customize the agent’s behavior
  • -rt, --require-toolkit TEXT: the name or url of a required toolkit
  • -rs, --require-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.2]
  • --image-generation TEXT: Name of an image gen model
  • --local-shell / --no-local-shell: Enable local shell tool calling [default: no-local-shell]
  • --shell / --no-shell: Enable function shell tool calling [default: no-shell]
  • --apply-patch / --no-apply-patch: Enable apply patch tool [default: no-apply-patch]
  • --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]
  • --web-fetch / --no-web-fetch: Enable web fetch tool calling [default: no-web-fetch]
  • --script-tool / --no-script-tool: Enable script tool calling [default: no-script-tool]
  • --discover-script-tools / --no-discover-script-tools: Automatically add script tools from the room [default: no-discover-script-tools]
  • --mcp / --no-mcp: Enable mcp tool calling [default: no-mcp]
  • --storage / --no-storage: Enable storage toolkit [default: no-storage]
  • --storage-tool-local-path TEXT: Mount local path as <source>:<mount>[:ro|rw]
  • --storage-tool-room-path TEXT: Mount room path as <source>:<mount>[:ro|rw]
  • --require-image-generation TEXT: Name of an image gen model
  • --require-local-shell / --no-require-local-shell: Enable local shell tool calling [default: no-require-local-shell]
  • --require-shell / --no-require-shell: Enable function shell tool calling [default: no-require-shell]
  • --require-apply-patch / --no-require-apply-patch: Enable apply patch tool [default: no-require-apply-patch]
  • --require-web-search / --no-require-web-search: Enable web search tool calling [default: no-require-web-search]
  • --require-web-fetch / --no-require-web-fetch: Enable web fetch tool calling [default: no-require-web-fetch]
  • --require-mcp / --no-require-mcp: Enable mcp tool calling [default: no-require-mcp]
  • --require-storage / --no-require-storage: Enable storage toolkit [default: no-require-storage]
  • --database-namespace TEXT: Use a specific database namespace
  • --require-table-read TEXT: Enable table read tools for a specific table
  • --require-table-write TEXT: Enable table write tools for a specific table
  • --require-read-only-storage / --no-require-read-only-storage: Enable read only storage toolkit [default: no-require-read-only-storage]
  • --require-time / --no-require-time: Enable time/datetime tools [default: require-time]
  • --require-uuid / --no-require-uuid: Enable UUID generation tools [default: no-require-uuid]
  • --working-directory TEXT: The default working directory for shell commands
  • --require-document-authoring / --no-require-document-authoring: Enable document authoring [default: no-require-document-authoring]
  • --require-discovery / --no-require-discovery: Enable discovery of agents and tools [default: no-require-discovery]
  • --llm-participant TEXT: Delegate LLM interactions to a remote participant
  • --host TEXT: Host to bind the service on
  • --port INTEGER: Port to bind the service on
  • --path TEXT: HTTP path to mount the service at
  • --always-reply / --no-always-reply: Always reply
  • --skill-dir TEXT: an agent skills directory
  • --shell-image TEXT: an image tag to use to run shell commands in
  • --delegate-shell-token / --no-delegate-shell-token: log all requests to the llm [default: no-delegate-shell-token]
  • --log-llm-requests / --no-log-llm-requests: log all requests to the llm [default: no-log-llm-requests]
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: The name of a room to create the service for
  • --help: Show this message and exit.

meshagent chatbot run

Usage:
$ meshagent chatbot run [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --role TEXT: [default: agent]
  • --agent-name TEXT: Name of the agent to call
  • -r, --rule TEXT: a system rule
  • -rr, --room-rules TEXT: a path to a rules file within the room that can be used to customize the agent’s behavior
  • --rules-file TEXT
  • -rt, --require-toolkit TEXT: the name or url of a required toolkit
  • -rs, --require-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.2]
  • --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]
  • --shell / --no-shell: Enable function shell tool calling [default: no-shell]
  • --apply-patch / --no-apply-patch: Enable apply patch tool [default: no-apply-patch]
  • --web-search / --no-web-search: Enable web search tool calling [default: no-web-search]
  • --web-fetch / --no-web-fetch: Enable web fetch tool calling [default: no-web-fetch]
  • --script-tool / --no-script-tool: Enable script tool calling [default: no-script-tool]
  • --discover-script-tools / --no-discover-script-tools: Automatically add script tools from the room [default: no-discover-script-tools]
  • --mcp / --no-mcp: Enable mcp tool calling [default: no-mcp]
  • --storage / --no-storage: Enable storage toolkit [default: no-storage]
  • --storage-tool-local-path TEXT: Mount local path as <source>:<mount>[:ro|rw]
  • --storage-tool-room-path TEXT: Mount room path as <source>:<mount>[:ro|rw]
  • --require-image-generation TEXT: Name of an image gen model
  • --require-local-shell / --no-require-local-shell: Enable local shell tool calling [default: no-require-local-shell]
  • --require-shell / --no-require-shell: Enable function shell tool calling [default: no-require-shell]
  • --require-apply-patch / --no-require-apply-patch: Enable apply patch tool calling [default: no-require-apply-patch]
  • --require-web-search / --no-require-web-search: Enable web search tool calling [default: no-require-web-search]
  • --require-web-fetch / --no-require-web-fetch: Enable web fetch tool calling [default: no-require-web-fetch]
  • --require-mcp / --no-require-mcp: Enable mcp tool calling [default: no-require-mcp]
  • --require-storage / --no-require-storage: Enable storage toolkit [default: no-require-storage]
  • --database-namespace TEXT: Use a specific database namespace
  • --require-table-read TEXT: Enable table read tools for a specific table
  • --require-table-write TEXT: Enable table write tools for a specific table
  • --require-read-only-storage / --no-require-read-only-storage: Enable read only storage toolkit [default: no-require-read-only-storage]
  • --require-time / --no-require-time: Enable time/datetime tools [default: require-time]
  • --require-uuid / --no-require-uuid: Enable UUID generation tools [default: no-require-uuid]
  • --require-document-authoring / --no-require-document-authoring: Enable MeshDocument authoring [default: no-require-document-authoring]
  • --require-discovery / --no-require-discovery: Enable discovery of agents and tools [default: no-require-discovery]
  • --working-directory TEXT: The default working directory for shell commands
  • --key TEXT: an api key to sign the token with
  • --llm-participant TEXT: Delegate LLM interactions to a remote participant
  • --always-reply / --no-always-reply: Always reply
  • --skill-dir TEXT: an agent skills directory
  • --shell-image TEXT: an image tag to use to run shell commands in
  • --delegate-shell-token / --no-delegate-shell-token: log all requests to the llm [default: no-delegate-shell-token]
  • --log-llm-requests / --no-log-llm-requests: log all requests to the llm [default: no-log-llm-requests]
  • --thread-path TEXT: log all requests to the llm
  • --message TEXT: the input message to use
  • --use-web-search / --no-use-web-search: request the web search tool
  • --use-image-gen / --no-use-image-gen: request the image gen tool
  • --use-storage / --no-use-storage: request the storage tool
  • --help: Show this message and exit.

meshagent chatbot use

Usage:
$ meshagent chatbot use [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --agent-name TEXT: Name of the agent to call
  • --thread-path TEXT: log all requests to the llm
  • --message TEXT: the input message to use
  • --use-web-search / --no-use-web-search: request the web search tool
  • --use-image-gen / --no-use-image-gen: request the image gen tool
  • --use-storage / --no-use-storage: request the storage tool
  • --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
  • spec
  • deploy

meshagent mailbot join

Usage:
$ meshagent mailbot join [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --role TEXT: [default: agent]
  • --agent-name TEXT: Name of the agent to call
  • -r, --rule TEXT: a system rule
  • --rules-file TEXT
  • -rt, --require-toolkit TEXT: the name or url of a required toolkit
  • -rs, --require-schema TEXT: the name or url of a required schema
  • -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.2]
  • --require-shell / --no-require-shell: Enable function shell tool calling [default: no-require-shell]
  • --require-local-shell / --no-require-local-shell: Enable local shell tool calling [default: no-require-local-shell]
  • --require-web-search / --no-require-web-search: Enable web search tool calling [default: no-require-web-search]
  • --require-web-fetch / --no-require-web-fetch: Enable web fetch tool calling [default: no-require-web-fetch]
  • --discover-script-tools / --no-discover-script-tools: Automatically add script tools from the room [default: no-discover-script-tools]
  • --require-apply-patch / --no-require-apply-patch: Enable apply patch tool calling [default: no-require-apply-patch]
  • --key TEXT: an api key to sign the token with
  • --queue TEXT: the name of the mail queue
  • --email-address TEXT: the email address of the agent [required]
  • --toolkit-name TEXT: the name of a toolkit to expose mail operations
  • -rr, --room-rules TEXT: a path to a rules file within the room that can be used to customize the agent’s behavior
  • --whitelist TEXT: an email to whitelist
  • --require-storage / --no-require-storage: Enable storage toolkit [default: no-require-storage]
  • --require-read-only-storage / --no-require-read-only-storage: Enable read only storage toolkit [default: no-require-read-only-storage]
  • --storage-tool-local-path TEXT: Mount local path as <source>:<mount>[:ro|rw]
  • --storage-tool-room-path TEXT: Mount room path as <source>:<mount>[:ro|rw]
  • --require-time / --no-require-time: Enable time/datetime tools [default: require-time]
  • --require-uuid / --no-require-uuid: Enable UUID generation tools [default: no-require-uuid]
  • --database-namespace TEXT: Use a specific database namespace
  • --require-table-read TEXT: Enable table read tools for a specific table
  • --require-table-write TEXT: Enable table write tools for a specific table
  • --reply-all / --no-reply-all: Reply-all when responding to emails [default: no-reply-all]
  • --enable-attachments / --no-enable-attachments: Allow downloading and processing email attachments [default: no-enable-attachments]
  • --working-directory TEXT: The default working directory for shell commands
  • --skill-dir TEXT: an agent skills directory
  • --llm-participant TEXT: Delegate LLM interactions to a remote participant
  • --shell-image TEXT: an image tag to use to run shell commands in
  • --delegate-shell-token / --no-delegate-shell-token: Delegate the room token to shell tools [default: no-delegate-shell-token]
  • --log-llm-requests / --no-log-llm-requests: log all requests to the llm [default: no-log-llm-requests]
  • --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
  • -rt, --require-toolkit TEXT: the name or url of a required toolkit
  • -rs, --require-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.2]
  • --require-shell / --no-require-shell: Enable function shell tool calling [default: no-require-shell]
  • --require-local-shell / --no-require-local-shell: Enable local shell tool calling [default: no-require-local-shell]
  • --require-web-search / --no-require-web-search: Enable web search tool calling [default: no-require-web-search]
  • --require-web-fetch / --no-require-web-fetch: Enable web fetch tool calling [default: no-require-web-fetch]
  • --discover-script-tools / --no-discover-script-tools: Automatically add script tools from the room [default: no-discover-script-tools]
  • --require-apply-patch / --no-require-apply-patch: Enable apply patch tool calling [default: no-require-apply-patch]
  • --host TEXT: Host to bind the service on
  • --port INTEGER: Port to bind the service on
  • --path TEXT: HTTP path to mount the service at
  • --queue TEXT: the name of the mail queue
  • --email-address TEXT: the email address of the agent [required]
  • --toolkit-name TEXT: the name of a toolkit to expose mail operations
  • -rr, --room-rules TEXT: a path to a rules file within the room that can be used to customize the agent’s behavior
  • --whitelist TEXT: an email to whitelist
  • --require-storage / --no-require-storage: Enable storage toolkit [default: no-require-storage]
  • --require-read-only-storage / --no-require-read-only-storage: Enable read only storage toolkit [default: no-require-read-only-storage]
  • --storage-tool-local-path TEXT: Mount local path as <source>:<mount>[:ro|rw]
  • --storage-tool-room-path TEXT: Mount room path as <source>:<mount>[:ro|rw]
  • --require-time / --no-require-time: Enable time/datetime tools [default: require-time]
  • --require-uuid / --no-require-uuid: Enable UUID generation tools [default: no-require-uuid]
  • --database-namespace TEXT: Use a specific database namespace
  • --require-table-read TEXT: Enable table read tools for a specific table
  • --require-table-write TEXT: Enable table write tools for a specific table
  • --reply-all / --no-reply-all: Reply-all when responding to emails [default: no-reply-all]
  • --enable-attachments / --no-enable-attachments: Allow downloading and processing email attachments [default: no-enable-attachments]
  • --working-directory TEXT: The default working directory for shell commands
  • --skill-dir TEXT: an agent skills directory
  • --llm-participant TEXT: Delegate LLM interactions to a remote participant
  • --shell-image TEXT: an image tag to use to run shell commands in
  • --delegate-shell-token / --no-delegate-shell-token: Delegate the room token to shell tools [default: no-delegate-shell-token]
  • --log-llm-requests / --no-log-llm-requests: log all requests to the llm [default: no-log-llm-requests]
  • --help: Show this message and exit.

meshagent mailbot spec

Usage:
$ meshagent mailbot spec [OPTIONS]
Options:
  • --service-name TEXT: service name [required]
  • --service-description TEXT: service description
  • --service-title TEXT: a display name for the service
  • --agent-name TEXT: Name of the agent to call [required]
  • -r, --rule TEXT: a system rule
  • --rules-file TEXT
  • -rt, --require-toolkit TEXT: the name or url of a required toolkit
  • -rs, --require-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.2]
  • --require-shell / --no-require-shell: Enable function shell tool calling [default: no-require-shell]
  • --require-local-shell / --no-require-local-shell: Enable local shell tool calling [default: no-require-local-shell]
  • --require-web-search / --no-require-web-search: Enable web search tool calling [default: no-require-web-search]
  • --require-web-fetch / --no-require-web-fetch: Enable web fetch tool calling [default: no-require-web-fetch]
  • --discover-script-tools / --no-discover-script-tools: Automatically add script tools from the room [default: no-discover-script-tools]
  • --require-apply-patch / --no-require-apply-patch: Enable apply patch tool calling [default: no-require-apply-patch]
  • --host TEXT: Host to bind the service on
  • --port INTEGER: Port to bind the service on
  • --path TEXT: HTTP path to mount the service at
  • --queue TEXT: the name of the mail queue
  • --email-address TEXT: the email address of the agent [required]
  • --toolkit-name TEXT: the name of a toolkit to expose mail operations
  • -rr, --room-rules TEXT: a path to a rules file within the room that can be used to customize the agent’s behavior
  • --whitelist TEXT: an email to whitelist
  • --require-storage / --no-require-storage: Enable storage toolkit [default: no-require-storage]
  • --require-read-only-storage / --no-require-read-only-storage: Enable read only storage toolkit [default: no-require-read-only-storage]
  • --storage-tool-local-path TEXT: Mount local path as <source>:<mount>[:ro|rw]
  • --storage-tool-room-path TEXT: Mount room path as <source>:<mount>[:ro|rw]
  • --require-time / --no-require-time: Enable time/datetime tools [default: require-time]
  • --require-uuid / --no-require-uuid: Enable UUID generation tools [default: no-require-uuid]
  • --database-namespace TEXT: Use a specific database namespace
  • --require-table-read TEXT: Enable table read tools for a specific table
  • --require-table-write TEXT: Enable table write tools for a specific table
  • --reply-all / --no-reply-all: Reply-all when responding to emails [default: no-reply-all]
  • --enable-attachments / --no-enable-attachments: Allow downloading and processing email attachments [default: no-enable-attachments]
  • --working-directory TEXT: The default working directory for shell commands
  • --skill-dir TEXT: an agent skills directory
  • --llm-participant TEXT: Delegate LLM interactions to a remote participant
  • --shell-image TEXT: an image tag to use to run shell commands in
  • --delegate-shell-token / --no-delegate-shell-token: Delegate the room token to shell tools [default: no-delegate-shell-token]
  • --log-llm-requests / --no-log-llm-requests: log all requests to the llm [default: no-log-llm-requests]
  • --help: Show this message and exit.

meshagent mailbot deploy

Usage:
$ meshagent mailbot deploy [OPTIONS]
Options:
  • --service-name TEXT: service name [required]
  • --service-description TEXT: service description
  • --service-title TEXT: a display name for the service
  • --agent-name TEXT: Name of the agent to call [required]
  • -r, --rule TEXT: a system rule
  • --rules-file TEXT
  • -rt, --require-toolkit TEXT: the name or url of a required toolkit
  • -rs, --require-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.2]
  • --require-shell / --no-require-shell: Enable function shell tool calling [default: no-require-shell]
  • --require-local-shell / --no-require-local-shell: Enable local shell tool calling [default: no-require-local-shell]
  • --require-web-search / --no-require-web-search: Enable web search tool calling [default: no-require-web-search]
  • --require-web-fetch / --no-require-web-fetch: Enable web fetch tool calling [default: no-require-web-fetch]
  • --discover-script-tools / --no-discover-script-tools: Automatically add script tools from the room [default: no-discover-script-tools]
  • --require-apply-patch / --no-require-apply-patch: Enable apply patch tool calling [default: no-require-apply-patch]
  • --host TEXT: Host to bind the service on
  • --port INTEGER: Port to bind the service on
  • --path TEXT: HTTP path to mount the service at
  • --queue TEXT: the name of the mail queue
  • --email-address TEXT: the email address of the agent [required]
  • --toolkit-name TEXT: the name of a toolkit to expose mail operations
  • -rr, --room-rules TEXT: a path to a rules file within the room that can be used to customize the agent’s behavior
  • --whitelist TEXT: an email to whitelist
  • --require-storage / --no-require-storage: Enable storage toolkit [default: no-require-storage]
  • --require-read-only-storage / --no-require-read-only-storage: Enable read only storage toolkit [default: no-require-read-only-storage]
  • --storage-tool-local-path TEXT: Mount local path as <source>:<mount>[:ro|rw]
  • --storage-tool-room-path TEXT: Mount room path as <source>:<mount>[:ro|rw]
  • --require-time / --no-require-time: Enable time/datetime tools [default: require-time]
  • --require-uuid / --no-require-uuid: Enable UUID generation tools [default: no-require-uuid]
  • --database-namespace TEXT: Use a specific database namespace
  • --require-table-read TEXT: Enable table read tools for a specific table
  • --require-table-write TEXT: Enable table write tools for a specific table
  • --reply-all / --no-reply-all: Reply-all when responding to emails [default: no-reply-all]
  • --enable-attachments / --no-enable-attachments: Allow downloading and processing email attachments [default: no-enable-attachments]
  • --working-directory TEXT: The default working directory for shell commands
  • --skill-dir TEXT: an agent skills directory
  • --llm-participant TEXT: Delegate LLM interactions to a remote participant
  • --shell-image TEXT: an image tag to use to run shell commands in
  • --delegate-shell-token / --no-delegate-shell-token: Delegate the room token to shell tools [default: no-delegate-shell-token]
  • --log-llm-requests / --no-log-llm-requests: log all requests to the llm [default: no-log-llm-requests]
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: The name of a room to create the service for
  • --help: Show this message and exit.

meshagent task-runner

Join a taskrunner to a room Usage:
$ meshagent task-runner [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • join
  • run
  • service
  • spec
  • deploy

meshagent task-runner join

Usage:
$ meshagent task-runner join [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --role TEXT: [default: agent]
  • --agent-name TEXT: Name of the agent to call
  • -r, --rule TEXT: a system rule
  • -rr, --room-rules TEXT: a path to a rules file within the room that can be used to customize the agent’s behavior
  • --rules-file TEXT
  • -rt, --require-toolkit TEXT: the name or url of a required toolkit
  • -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 task runner [default: gpt-5.2]
  • --image-generation TEXT: Name of an image gen model
  • --local-shell / --no-local-shell: Enable local shell tool calling [default: no-local-shell]
  • --shell / --no-shell: Enable function shell tool calling [default: no-shell]
  • --apply-patch / --no-apply-patch: Enable apply patch tool [default: no-apply-patch]
  • --web-search / --no-web-search: Enable web search tool calling [default: no-web-search]
  • --web-fetch / --no-web-fetch: Enable web fetch tool calling [default: no-web-fetch]
  • --discover-script-tools / --no-discover-script-tools: Automatically add script tools from the room [default: no-discover-script-tools]
  • --mcp / --no-mcp: Enable mcp tool calling [default: no-mcp]
  • --storage / --no-storage: Enable storage toolkit [default: no-storage]
  • --storage-tool-local-path TEXT: Mount local path as <source>:<mount>[:ro|rw]
  • --storage-tool-room-path TEXT: Mount room path as <source>:<mount>[:ro|rw]
  • --require-uuid / --no-require-uuid: Enable UUID generation tools [default: no-require-uuid]
  • --working-directory TEXT: The default working directory for shell commands
  • --delegate-shell-token / --no-delegate-shell-token: Delegate the room token to shell tools [default: no-delegate-shell-token]
  • --key TEXT: an api key to sign the token with
  • -a, --annotations TEXT: annotations in json format {“name”:“value”} [default: {“meshagent.task-runner.attachment-format”:“tar”}]
  • --title TEXT: a friendly name for the task runner
  • --description TEXT: a description for the task runner
  • --allow-model-selection / --no-allow-model-selection: a description for the task runner [default: allow-model-selection]
  • --allow-thread-selection / --no-allow-thread-selection: allow selecting a thread via input path for task context [default: no-allow-thread-selection]
  • --log-llm-requests / --no-log-llm-requests: log all requests to the llm [default: no-log-llm-requests]
  • --help: Show this message and exit.

meshagent task-runner run

Usage:
$ meshagent task-runner run [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --role TEXT: [default: agent]
  • --agent-name TEXT: Name of the agent to call
  • -r, --rule TEXT: a system rule
  • -rr, --room-rules TEXT: a path to a rules file within the room that can be used to customize the agent’s behavior
  • --rules-file TEXT
  • -rt, --require-toolkit TEXT: the name or url of a required toolkit
  • -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 task runner [default: gpt-5.2]
  • --image-generation TEXT: Name of an image gen model
  • --local-shell / --no-local-shell: Enable local shell tool calling [default: no-local-shell]
  • --shell / --no-shell: Enable function shell tool calling [default: no-shell]
  • --apply-patch / --no-apply-patch: Enable apply patch tool [default: no-apply-patch]
  • --web-search / --no-web-search: Enable web search tool calling [default: no-web-search]
  • --web-fetch / --no-web-fetch: Enable web fetch tool calling [default: no-web-fetch]
  • --discover-script-tools / --no-discover-script-tools: Automatically add script tools from the room [default: no-discover-script-tools]
  • --mcp / --no-mcp: Enable mcp tool calling [default: no-mcp]
  • --storage / --no-storage: Enable storage toolkit [default: no-storage]
  • --storage-tool-local-path TEXT: Mount local path as <source>:<mount>[:ro|rw]
  • --storage-tool-room-path TEXT: Mount room path as <source>:<mount>[:ro|rw]
  • --require-uuid / --no-require-uuid: Enable UUID generation tools [default: no-require-uuid]
  • --working-directory TEXT: The default working directory for shell commands
  • --delegate-shell-token / --no-delegate-shell-token: Delegate the room token to shell tools [default: no-delegate-shell-token]
  • --key TEXT: an api key to sign the token with
  • -a, --annotations TEXT: annotations in json format {“name”:“value”} [default: {“meshagent.task-runner.attachment-format”:“tar”}]
  • --title TEXT: a friendly name for the task runner
  • --description TEXT: a description for the task runner
  • --allow-model-selection / --no-allow-model-selection: a description for the task runner [default: allow-model-selection]
  • --allow-thread-selection / --no-allow-thread-selection: allow selecting a thread via input path for task context [default: no-allow-thread-selection]
  • --input TEXT: json input for the task runner, or ’-’ for stdin
  • --log-llm-requests / --no-log-llm-requests: log all requests to the llm [default: no-log-llm-requests]
  • --with-caller / --no-with-caller: whether to invoke the tool with the currently logged in user as the caller [default: with-caller]
  • --help: Show this message and exit.

meshagent task-runner service

Usage:
$ meshagent task-runner service [OPTIONS]
Options:
  • --agent-name TEXT: Name of the agent to call [required]
  • -r, --rule TEXT: a system rule
  • --rules-file TEXT
  • -rr, --room-rules TEXT: a path to a rules file within the room that can be used to customize the agent’s behavior
  • -rt, --require-toolkit TEXT: the name or url of a required toolkit
  • -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 task runner [default: gpt-5.2]
  • --image-generation TEXT: Name of an image gen model
  • --local-shell / --no-local-shell: Enable local shell tool calling [default: no-local-shell]
  • --shell / --no-shell: Enable function shell tool calling [default: no-shell]
  • --apply-patch / --no-apply-patch: Enable apply patch tool [default: no-apply-patch]
  • --web-search / --no-web-search: Enable web search tool calling [default: no-web-search]
  • --web-fetch / --no-web-fetch: Enable web fetch tool calling [default: no-web-fetch]
  • --discover-script-tools / --no-discover-script-tools: Automatically add script tools from the room [default: no-discover-script-tools]
  • --mcp / --no-mcp: Enable mcp tool calling [default: no-mcp]
  • --storage / --no-storage: Enable storage toolkit [default: no-storage]
  • --storage-tool-local-path TEXT: Mount local path as <source>:<mount>[:ro|rw]
  • --storage-tool-room-path TEXT: Mount room path as <source>:<mount>[:ro|rw]
  • --require-uuid / --no-require-uuid: Enable UUID generation tools [default: no-require-uuid]
  • --working-directory TEXT: The default working directory for shell commands
  • --delegate-shell-token / --no-delegate-shell-token: Delegate the room token to shell tools [default: no-delegate-shell-token]
  • --host TEXT: Host to bind the service on
  • --port INTEGER: Port to bind the service on
  • --path TEXT: HTTP path to mount the service at
  • -a, --annotations TEXT: annotations in json format {“name”:“value”} [default: {“meshagent.task-runner.attachment-format”:“tar”}]
  • --title TEXT: a friendly name for the task runner
  • --description TEXT: a description for the task runner
  • --allow-model-selection / --no-allow-model-selection: a description for the task runner [default: allow-model-selection]
  • --allow-thread-selection / --no-allow-thread-selection: allow selecting a thread via input path for task context [default: no-allow-thread-selection]
  • --log-llm-requests / --no-log-llm-requests: log all requests to the llm [default: no-log-llm-requests]
  • --help: Show this message and exit.

meshagent task-runner spec

Usage:
$ meshagent task-runner spec [OPTIONS]
Options:
  • --service-name TEXT: service name [required]
  • --service-description TEXT: service description
  • --service-title TEXT: a display name for the service
  • --agent-name TEXT: Name of the agent to call [required]
  • -r, --rule TEXT: a system rule
  • --rules-file TEXT
  • -rr, --room-rules TEXT: a path to a rules file within the room that can be used to customize the agent’s behavior
  • -rt, --require-toolkit TEXT: the name or url of a required toolkit
  • -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 task runner [default: gpt-5.2]
  • --image-generation TEXT: Name of an image gen model
  • --local-shell / --no-local-shell: Enable local shell tool calling [default: no-local-shell]
  • --shell / --no-shell: Enable function shell tool calling [default: no-shell]
  • --apply-patch / --no-apply-patch: Enable apply patch tool [default: no-apply-patch]
  • --web-search / --no-web-search: Enable web search tool calling [default: no-web-search]
  • --web-fetch / --no-web-fetch: Enable web fetch tool calling [default: no-web-fetch]
  • --discover-script-tools / --no-discover-script-tools: Automatically add script tools from the room [default: no-discover-script-tools]
  • --mcp / --no-mcp: Enable mcp tool calling [default: no-mcp]
  • --storage / --no-storage: Enable storage toolkit [default: no-storage]
  • --storage-tool-local-path TEXT: Mount local path as <source>:<mount>[:ro|rw]
  • --storage-tool-room-path TEXT: Mount room path as <source>:<mount>[:ro|rw]
  • --require-uuid / --no-require-uuid: Enable UUID generation tools [default: no-require-uuid]
  • --working-directory TEXT: The default working directory for shell commands
  • --delegate-shell-token / --no-delegate-shell-token: Delegate the room token to shell tools [default: no-delegate-shell-token]
  • --host TEXT: Host to bind the service on
  • --port INTEGER: Port to bind the service on
  • --path TEXT: HTTP path to mount the service at
  • -a, --annotations TEXT: annotations in json format {“name”:“value”} [default: {“meshagent.task-runner.attachment-format”:“tar”}]
  • --title TEXT: a friendly name for the task runner
  • --description TEXT: a description for the task runner
  • --allow-model-selection / --no-allow-model-selection: a description for the task runner [default: allow-model-selection]
  • --allow-thread-selection / --no-allow-thread-selection: allow selecting a thread via input path for task context [default: no-allow-thread-selection]
  • --log-llm-requests / --no-log-llm-requests: log all requests to the llm [default: no-log-llm-requests]
  • --help: Show this message and exit.

meshagent task-runner deploy

Usage:
$ meshagent task-runner deploy [OPTIONS]
Options:
  • --service-name TEXT: service name [required]
  • --service-description TEXT: service description
  • --service-title TEXT: a display name for the service
  • --agent-name TEXT: Name of the agent to call [required]
  • -r, --rule TEXT: a system rule
  • --rules-file TEXT
  • -rr, --room-rules TEXT: a path to a rules file within the room that can be used to customize the agent’s behavior
  • -rt, --require-toolkit TEXT: the name or url of a required toolkit
  • -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 task runner [default: gpt-5.2]
  • --image-generation TEXT: Name of an image gen model
  • --local-shell / --no-local-shell: Enable local shell tool calling [default: no-local-shell]
  • --shell / --no-shell: Enable function shell tool calling [default: no-shell]
  • --apply-patch / --no-apply-patch: Enable apply patch tool [default: no-apply-patch]
  • --web-search / --no-web-search: Enable web search tool calling [default: no-web-search]
  • --web-fetch / --no-web-fetch: Enable web fetch tool calling [default: no-web-fetch]
  • --discover-script-tools / --no-discover-script-tools: Automatically add script tools from the room [default: no-discover-script-tools]
  • --mcp / --no-mcp: Enable mcp tool calling [default: no-mcp]
  • --storage / --no-storage: Enable storage toolkit [default: no-storage]
  • --storage-tool-local-path TEXT: Mount local path as <source>:<mount>[:ro|rw]
  • --storage-tool-room-path TEXT: Mount room path as <source>:<mount>[:ro|rw]
  • --require-uuid / --no-require-uuid: Enable UUID generation tools [default: no-require-uuid]
  • --working-directory TEXT: The default working directory for shell commands
  • --delegate-shell-token / --no-delegate-shell-token: Delegate the room token to shell tools [default: no-delegate-shell-token]
  • --host TEXT: Host to bind the service on
  • --port INTEGER: Port to bind the service on
  • --path TEXT: HTTP path to mount the service at
  • -a, --annotations TEXT: annotations in json format {“name”:“value”} [default: {“meshagent.task-runner.attachment-format”:“tar”}]
  • --title TEXT: a friendly name for the task runner
  • --description TEXT: a description for the task runner
  • --allow-model-selection / --no-allow-model-selection: a description for the task runner [default: allow-model-selection]
  • --allow-thread-selection / --no-allow-thread-selection: allow selecting a thread via input path for task context [default: no-allow-thread-selection]
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: The name of a room to create the service for
  • --log-llm-requests / --no-log-llm-requests: log all requests to the llm [default: no-log-llm-requests]
  • --help: Show this message and exit.

meshagent worker

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

meshagent worker join

Usage:
$ meshagent worker join [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --role TEXT: [default: agent]
  • --agent-name TEXT: Name of the worker agent
  • -r, --rule TEXT: a system rule
  • --rules-file TEXT
  • -rt, --require-toolkit TEXT: the name or url of a required toolkit
  • -rs, --require-schema TEXT: the name or url of a required schema
  • --model TEXT: Name of the LLM model to use [default: gpt-5.2]
  • --require-shell / --no-require-shell: Enable function shell tool calling [default: no-require-shell]
  • --require-local-shell / --no-require-local-shell: Enable local shell tool calling [default: no-require-local-shell]
  • --require-web-search / --no-require-web-search: Require web search tool [default: no-require-web-search]
  • --require-web-fetch / --no-require-web-fetch: Require web fetch tool [default: no-require-web-fetch]
  • --require-apply-patch / --no-require-apply-patch: Enable apply patch tool calling [default: no-require-apply-patch]
  • --key TEXT: an api key to sign the token with
  • --queue TEXT: the queue to consume [required]
  • --toolkit-name TEXT: optional toolkit name to expose worker operations
  • -rr, --room-rules TEXT: path(s) in room storage to load rules from
  • --image-generation TEXT: Name of an image gen model
  • --local-shell / --no-local-shell: Enable local shell tool calling [default: no-local-shell]
  • --shell / --no-shell: Enable function shell tool calling [default: no-shell]
  • --apply-patch / --no-apply-patch: Enable apply patch tool [default: no-apply-patch]
  • --web-search / --no-web-search: Enable web search tool calling [default: no-web-search]
  • --web-fetch / --no-web-fetch: Enable web fetch tool calling [default: no-web-fetch]
  • --discover-script-tools / --no-discover-script-tools: Automatically add script tools from the room [default: no-discover-script-tools]
  • --mcp / --no-mcp: Enable mcp tool calling [default: no-mcp]
  • --storage / --no-storage: Enable storage toolkit [default: no-storage]
  • --storage-tool-local-path TEXT: Mount local path as <source>:<mount>[:ro|rw]
  • --storage-tool-room-path TEXT: Mount room path as <source>:<mount>[:ro|rw]
  • --require-storage / --no-require-storage: Enable storage toolkit [default: no-require-storage]
  • --require-read-only-storage / --no-require-read-only-storage: Enable read only storage toolkit [default: no-require-read-only-storage]
  • --require-time / --no-require-time: Enable time/datetime tools [default: require-time]
  • --require-uuid / --no-require-uuid: Enable UUID generation tools [default: no-require-uuid]
  • --database-namespace TEXT: Use a specific database namespace (JSON list or dotted)
  • --require-table-read TEXT: Enable table read tools for these tables
  • --require-table-write TEXT: Enable table write tools for these tables
  • --title TEXT: a display name for the agent
  • --description TEXT: a description for the agent
  • --working-directory TEXT: The default working directory for shell commands
  • --skill-dir TEXT: an agent skills directory
  • --shell-image TEXT: an image tag to use to run shell commands in
  • --delegate-shell-token / --no-delegate-shell-token: Delegate the room token to shell tools [default: no-delegate-shell-token]
  • --log-llm-requests / --no-log-llm-requests: log all requests to the llm [default: no-log-llm-requests]
  • --prompt TEXT: a prompt to use for the worker
  • --help: Show this message and exit.

meshagent worker service

Usage:
$ meshagent worker service [OPTIONS]
Options:
  • --agent-name TEXT: Name of the worker agent [required]
  • -r, --rule TEXT: a system rule
  • --rules-file TEXT
  • -rt, --require-toolkit TEXT: the name or url of a required toolkit
  • -rs, --require-schema TEXT: the name or url of a required schema
  • --model TEXT: Name of the LLM model to use [default: gpt-5.2]
  • --image-generation TEXT: Name of an image gen model
  • --require-shell / --no-require-shell: Enable function shell tool calling [default: no-require-shell]
  • --local-shell / --no-local-shell: Enable local shell tool calling [default: no-local-shell]
  • --shell / --no-shell: Enable function shell tool calling [default: no-shell]
  • --apply-patch / --no-apply-patch: Enable apply patch tool [default: no-apply-patch]
  • --web-search / --no-web-search: Enable web search tool calling [default: no-web-search]
  • --web-fetch / --no-web-fetch: Enable web fetch tool calling [default: no-web-fetch]
  • --discover-script-tools / --no-discover-script-tools: Automatically add script tools from the room [default: no-discover-script-tools]
  • --mcp / --no-mcp: Enable mcp tool calling [default: no-mcp]
  • --storage / --no-storage: Enable storage toolkit [default: no-storage]
  • --storage-tool-local-path TEXT: Mount local path as <source>:<mount>[:ro|rw]
  • --storage-tool-room-path TEXT: Mount room path as <source>:<mount>[:ro|rw]
  • --require-local-shell / --no-require-local-shell: Require local shell tool [default: no-require-local-shell]
  • --require-web-search / --no-require-web-search: Require web search tool [default: no-require-web-search]
  • --require-web-fetch / --no-require-web-fetch: Require web fetch tool [default: no-require-web-fetch]
  • --require-apply-patch / --no-require-apply-patch: Enable apply patch tool calling [default: no-require-apply-patch]
  • --host TEXT: Host to bind the service on
  • --port INTEGER: Port to bind the service on
  • --path TEXT: HTTP path to mount the service at
  • --queue TEXT: the queue to consume [required]
  • --toolkit-name TEXT: Toolkit name to expose (optional)
  • -rr, --room-rules TEXT: Path(s) to rules files inside the room
  • --require-storage / --no-require-storage: Require storage toolkit [default: no-require-storage]
  • --require-read-only-storage / --no-require-read-only-storage: Require read-only storage toolkit [default: no-require-read-only-storage]
  • --require-time / --no-require-time: Enable time/datetime tools [default: require-time]
  • --require-uuid / --no-require-uuid: Enable UUID generation tools [default: no-require-uuid]
  • --database-namespace TEXT: Database namespace (e.g. foo::bar)
  • --require-table-read TEXT: Require table read tool for table (repeatable)
  • --require-table-write TEXT: Require table write tool for table (repeatable)
  • --title TEXT: a display name for the agent
  • --description TEXT: a description for the agent
  • --working-directory TEXT: The default working directory for shell commands
  • --skill-dir TEXT: an agent skills directory
  • --shell-image TEXT: an image tag to use to run shell commands in
  • --delegate-shell-token / --no-delegate-shell-token: Delegate the room token to shell tools [default: no-delegate-shell-token]
  • --log-llm-requests / --no-log-llm-requests: log all requests to the llm [default: no-log-llm-requests]
  • --prompt TEXT: a prompt to use for the worker
  • --help: Show this message and exit.

meshagent worker spec

Usage:
$ meshagent worker spec [OPTIONS]
Options:
  • --service-name TEXT: service name [required]
  • --service-description TEXT: service description
  • --service-title TEXT: a display name for the service
  • --agent-name TEXT: Name of the worker agent [required]
  • -r, --rule TEXT: a system rule
  • --rules-file TEXT
  • -rt, --require-toolkit TEXT: the name or url of a required toolkit
  • -rs, --require-schema TEXT: the name or url of a required schema
  • --model TEXT: Name of the LLM model to use [default: gpt-5.2]
  • --image-generation TEXT: Name of an image gen model
  • --require-shell / --no-require-shell: Enable function shell tool calling [default: no-require-shell]
  • --local-shell / --no-local-shell: Enable local shell tool calling [default: no-local-shell]
  • --shell / --no-shell: Enable function shell tool calling [default: no-shell]
  • --apply-patch / --no-apply-patch: Enable apply patch tool [default: no-apply-patch]
  • --web-search / --no-web-search: Enable web search tool calling [default: no-web-search]
  • --web-fetch / --no-web-fetch: Enable web fetch tool calling [default: no-web-fetch]
  • --discover-script-tools / --no-discover-script-tools: Automatically add script tools from the room [default: no-discover-script-tools]
  • --mcp / --no-mcp: Enable mcp tool calling [default: no-mcp]
  • --storage / --no-storage: Enable storage toolkit [default: no-storage]
  • --storage-tool-local-path TEXT: Mount local path as <source>:<mount>[:ro|rw]
  • --storage-tool-room-path TEXT: Mount room path as <source>:<mount>[:ro|rw]
  • --require-local-shell / --no-require-local-shell: Require local shell tool [default: no-require-local-shell]
  • --require-web-search / --no-require-web-search: Require web search tool [default: no-require-web-search]
  • --require-web-fetch / --no-require-web-fetch: Require web fetch tool [default: no-require-web-fetch]
  • --require-apply-patch / --no-require-apply-patch: Enable apply patch tool calling [default: no-require-apply-patch]
  • --host TEXT: Host to bind the service on
  • --port INTEGER: Port to bind the service on
  • --path TEXT: HTTP path to mount the service at
  • --queue TEXT: the queue to consume [required]
  • --toolkit-name TEXT: Toolkit name to expose (optional)
  • -rr, --room-rules TEXT: Path(s) to rules files inside the room
  • --require-storage / --no-require-storage: Require storage toolkit [default: no-require-storage]
  • --require-read-only-storage / --no-require-read-only-storage: Require read-only storage toolkit [default: no-require-read-only-storage]
  • --require-time / --no-require-time: Enable time/datetime tools [default: require-time]
  • --require-uuid / --no-require-uuid: Enable UUID generation tools [default: no-require-uuid]
  • --database-namespace TEXT: Database namespace (e.g. foo::bar)
  • --require-table-read TEXT: Require table read tool for table (repeatable)
  • --require-table-write TEXT: Require table write tool for table (repeatable)
  • --title TEXT: a display name for the agent
  • --description TEXT: a description for the agent
  • --working-directory TEXT: The default working directory for shell commands
  • --skill-dir TEXT: an agent skills directory
  • --shell-image TEXT: an image tag to use to run shell commands in
  • --delegate-shell-token / --no-delegate-shell-token: Delegate the room token to shell tools [default: no-delegate-shell-token]
  • --log-llm-requests / --no-log-llm-requests: log all requests to the llm [default: no-log-llm-requests]
  • --prompt TEXT: a prompt to use for the worker
  • --help: Show this message and exit.

meshagent worker deploy

Usage:
$ meshagent worker deploy [OPTIONS]
Options:
  • --service-name TEXT: service name [required]
  • --service-description TEXT: service description
  • --service-title TEXT: a display name for the service
  • --agent-name TEXT: Name of the worker agent [required]
  • -r, --rule TEXT: a system rule
  • --rules-file TEXT
  • -rt, --require-toolkit TEXT: the name or url of a required toolkit
  • -rs, --require-schema TEXT: the name or url of a required schema
  • --model TEXT: Name of the LLM model to use [default: gpt-5.2]
  • --image-generation TEXT: Name of an image gen model
  • --require-shell / --no-require-shell: Enable function shell tool calling [default: no-require-shell]
  • --local-shell / --no-local-shell: Enable local shell tool calling [default: no-local-shell]
  • --shell / --no-shell: Enable function shell tool calling [default: no-shell]
  • --apply-patch / --no-apply-patch: Enable apply patch tool [default: no-apply-patch]
  • --web-search / --no-web-search: Enable web search tool calling [default: no-web-search]
  • --web-fetch / --no-web-fetch: Enable web fetch tool calling [default: no-web-fetch]
  • --discover-script-tools / --no-discover-script-tools: Automatically add script tools from the room [default: no-discover-script-tools]
  • --mcp / --no-mcp: Enable mcp tool calling [default: no-mcp]
  • --storage / --no-storage: Enable storage toolkit [default: no-storage]
  • --storage-tool-local-path TEXT: Mount local path as <source>:<mount>[:ro|rw]
  • --storage-tool-room-path TEXT: Mount room path as <source>:<mount>[:ro|rw]
  • --require-local-shell / --no-require-local-shell: Require local shell tool [default: no-require-local-shell]
  • --require-web-search / --no-require-web-search: Require web search tool [default: no-require-web-search]
  • --require-web-fetch / --no-require-web-fetch: Require web fetch tool [default: no-require-web-fetch]
  • --require-apply-patch / --no-require-apply-patch: Enable apply patch tool calling [default: no-require-apply-patch]
  • --host TEXT: Host to bind the service on
  • --port INTEGER: Port to bind the service on
  • --path TEXT: HTTP path to mount the service at
  • --queue TEXT: the queue to consume [required]
  • --toolkit-name TEXT: Toolkit name to expose (optional)
  • -rr, --room-rules TEXT: Path(s) to rules files inside the room
  • --require-storage / --no-require-storage: Require storage toolkit [default: no-require-storage]
  • --require-read-only-storage / --no-require-read-only-storage: Require read-only storage toolkit [default: no-require-read-only-storage]
  • --require-time / --no-require-time: Enable time/datetime tools [default: require-time]
  • --require-uuid / --no-require-uuid: Enable UUID generation tools [default: no-require-uuid]
  • --database-namespace TEXT: Database namespace (e.g. foo::bar)
  • --require-table-read TEXT: Require table read tool for table (repeatable)
  • --require-table-write TEXT: Require table write tool for table (repeatable)
  • --title TEXT: a display name for the agent
  • --description TEXT: a description for the agent
  • --working-directory TEXT: The default working directory for shell commands
  • --skill-dir TEXT: an agent skills directory
  • --shell-image TEXT: an image tag to use to run shell commands in
  • --delegate-shell-token / --no-delegate-shell-token: Delegate the room token to shell tools [default: no-delegate-shell-token]
  • --log-llm-requests / --no-log-llm-requests: log all requests to the llm [default: no-log-llm-requests]
  • --prompt TEXT: a prompt to use for the worker
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: The name of a room to create the service for
  • --help: Show this message and exit.

meshagent room

Operate within a room Usage:
$ meshagent room [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • agents: Interact with agents and toolkits
  • secrets: Manage secrets for your project
  • queue: Use queues in a room
  • messaging: Send and receive messages
  • storage: Manage storage for a room
  • services: Manage services in a room
  • developer: Developer utilities for a room
  • database: Manage database tables in a room
  • container: Manage containers and images in a room
  • sync: Inspect and update mesh documents in a room

meshagent room agents

Interact with agents and toolkits Usage:
$ meshagent room agents [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • invoke-tool: Invoke a specific tool from a toolkit
  • list-toolkits: List toolkits (and tools) available in the…

meshagent room agents invoke-tool

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

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

meshagent room secrets

Manage secrets for your project Usage:
$ meshagent room secrets [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • oauth: Run an OAuth2 request test between two…
  • request: Request a secret from another participant.
  • get: Get a stored secret by secret id.
  • set: Set/store a secret (bytes from stdin,…
  • list: list secrets
  • delete: delete a secret

meshagent room secrets oauth

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 room secrets oauth [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --from-participant-id TEXT: Participant ID to request the token from [required]
  • --client-id TEXT: OAuth client ID [required]
  • --authorization-endpoint TEXT: OAuth authorization endpoint URL [required]
  • --token-endpoint TEXT: OAuth token endpoint URL [required]
  • --scopes TEXT: Comma-separated OAuth scopes
  • --client-secret TEXT: OAuth client secret (if required) [required]
  • --redirect-uri TEXT: Redirect URI for the OAuth flow [required]
  • --pkce / --no-pkce: Use PKCE (recommended) [default: pkce]
  • --help: Show this message and exit.

meshagent room secrets request

Request a secret from another participant. Usage:
$ meshagent room secrets request [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --from-participant-id TEXT: Participant ID to request the secret from [required]
  • --url TEXT: Secret URL identifier [required]
  • --type TEXT: Secret type [default: application/octet-stream]
  • --delegate-to TEXT: Delegate secret to this participant name
  • --timeout INTEGER: Timeout in seconds [default: 300]
  • -o, --out TEXT: Output file path, or ’-’ for stdout [default: -]
  • --help: Show this message and exit.

meshagent room secrets get

Get a stored secret by secret id. Usage:
$ meshagent room secrets get [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --secret-id TEXT: Secret ID [required]
  • --delegated-to TEXT: Fetch a secret delegated to this participant name
  • -o, --out TEXT: Output file path, or ’-’ for stdout [default: -]
  • --help: Show this message and exit.

meshagent room secrets set

Set/store a secret (bytes from stdin, file, text, or base64). Usage:
$ meshagent room secrets set [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --secret-id TEXT: Secret ID [required]
  • --type TEXT: Secret type
  • --name TEXT: Optional secret name
  • --delegated-to TEXT: Store a secret delegated to this participant name
  • --for-identity TEXT: Store a secret for a specific identity
  • -i, --in TEXT: Input file path, or ’-’ for stdin
  • --text TEXT: Provide secret as UTF-8 text
  • --base64 TEXT: Provide secret as base64-encoded data
  • --help: Show this message and exit.

meshagent room secrets list

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

meshagent room secrets delete

delete a secret Usage:
$ meshagent room secrets delete [OPTIONS] ID
Arguments:
  • ID: [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --delegated-to TEXT: The value of the delegated_to field of the secret, must be specified if secret was delegated
  • --help: Show this message and exit.

meshagent room queue

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

meshagent room queue send

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

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

meshagent room messaging

Send and receive messages Usage:
$ meshagent room messaging [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • list: List messaging-enabled participants
  • send: Send a direct message to a participant
  • broadcast: Broadcast a message to all participants

meshagent room messaging list

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

meshagent room messaging send

Send a direct message to a participant Usage:
$ meshagent room messaging send [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --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 room messaging broadcast

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

meshagent room storage

Manage storage for a room Usage:
$ meshagent room 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 room storage exists

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

meshagent room storage cp

Usage:
$ meshagent room 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. [required]
  • --room TEXT: Room name [required]
  • --help: Show this message and exit.

meshagent room storage show

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

meshagent room 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 room storage rm [OPTIONS] PATH
Arguments:
  • PATH: [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -r: Remove directories/folders recursively
  • --help: Show this message and exit.

meshagent room 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 room 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. [required]
  • --room TEXT: Room name [required]
  • -r: List subfolders/files recursively
  • --help: Show this message and exit.

meshagent room services

Manage services in a room Usage:
$ meshagent room services [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • list: List services running in a room

meshagent room services list

List services running in a room Usage:
$ meshagent room services list [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -o, --output TEXT: output format [default: table]
  • --help: Show this message and exit.

meshagent room developer

Developer utilities for a room Usage:
$ meshagent room developer [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • watch: Stream developer logs from a room

meshagent room developer watch

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

meshagent room database

Manage database tables in a room Usage:
$ meshagent room database [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • tables
  • inspect
  • install: Create a database from a json file…
  • create: Create a table with optional schema +…
  • drop
  • add-columns: Add columns.
  • drop-columns
  • insert
  • merge
  • update
  • delete
  • search
  • optimize
  • versions
  • checkout
  • restore
  • indexes
  • index-create
  • index-drop

meshagent room database tables

Usage:
$ meshagent room database tables [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --help: Show this message and exit.

meshagent room database inspect

Usage:
$ meshagent room database inspect [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -t, --table TEXT: Table name [required]
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --json: Output raw schema JSON
  • --help: Show this message and exit.

meshagent room database install

Create a database from a json file containing a list of RequiredTables. Usage:
$ meshagent room database install [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --file TEXT: Path to requirements JSON file
  • --help: Show this message and exit.

meshagent room database create

Create a table with optional schema + optional initial data. Schema JSON format matches your DataType.to_json() structure, e.g.: {“id”:{“type”:“int”}, “body”:{“type”:“text”}, “embedding”:{“type”:“vector”,“size”:1536,“element_type”:{“type”:“float”}}} Column definitions via —columns/-c use SQL-like syntax: names vector(20) null, test text not null, age int Allowed types: int, bool, date, timestamp, float, text, binary, vector. Vector syntax: vector(size[, element_type]). Usage:
$ meshagent room database create [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -t, --table TEXT: Table name [required]
  • --mode TEXT: create | overwrite | create_if_not_exists [default: create]
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • -c, --columns TEXT: Comma-separated column definitions. Example: “names vector(20) null, test text not null, age int”. Allowed types: int, bool, date, timestamp, float, text, binary, vector. Vector syntax: vector(size[, element_type]).
  • --schema-json TEXT: Schema JSON as a string
  • --schema-file TEXT: Path to schema JSON file
  • --data-json TEXT: Initial rows (JSON list)
  • --data-file TEXT: Path to JSON file with initial rows
  • --help: Show this message and exit.

meshagent room database drop

Usage:
$ meshagent room database drop [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -t, --table TEXT: Table name [required]
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --ignore-missing: Ignore missing table
  • --help: Show this message and exit.

meshagent room database add-columns

Add columns. JSON supports either:
  • DataType JSON: {“col”:{“type”:“text”}}
  • or server default SQL expr strings: {“col”:“‘default’”}
Column definitions via —columns/-c use SQL-like syntax: names vector(20) null, test text not null, age int Allowed types: int, bool, date, timestamp, float, text, binary, vector. Vector syntax: vector(size[, element_type]). Usage:
$ meshagent room database add-columns [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -t, --table TEXT: Table name [required]
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • -c, --columns TEXT: Comma-separated column definitions. Example: “names vector(20) null, test text not null, age int”. Allowed types: int, bool, date, timestamp, float, text, binary, vector. Vector syntax: vector(size[, element_type]).
  • --columns-json TEXT: JSON object of new columns
  • --help: Show this message and exit.

meshagent room database drop-columns

Usage:
$ meshagent room database drop-columns [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -t, --table TEXT: Table name [required]
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • -c, --column TEXT: Column to drop (repeatable)
  • --help: Show this message and exit.

meshagent room database insert

Usage:
$ meshagent room database insert [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -t, --table TEXT: Table name [required]
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --json TEXT: JSON list of records
  • -f, --file TEXT: Path to JSON file (list of records)
  • --help: Show this message and exit.

meshagent room database merge

Usage:
$ meshagent room database merge [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -t, --table TEXT: Table name [required]
  • --on TEXT: Column to match for upsert [required]
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --json TEXT: JSON records (list)
  • -f, --file TEXT: Path to JSON file (list)
  • --help: Show this message and exit.

meshagent room database update

Usage:
$ meshagent room database update [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -t, --table TEXT: Table name [required]
  • --where TEXT: SQL WHERE clause, e.g. “id = 1” [required]
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --values-json TEXT: JSON object of literal values
  • --values-sql-json TEXT: JSON object of SQL expressions
  • --help: Show this message and exit.

meshagent room database delete

Usage:
$ meshagent room database delete [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -t, --table TEXT: Table name [required]
  • --where TEXT: SQL WHERE clause [required]
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --help: Show this message and exit.
Usage:
$ meshagent room database search [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -t, --table TEXT: Table name [required]
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --text TEXT: Full-text query
  • --vector-json TEXT: Vector JSON array
  • --where TEXT: SQL WHERE clause
  • --where-json TEXT: JSON object converted to equality ANDs
  • --select TEXT: Columns to select (repeatable)
  • --limit INTEGER: Max rows to return
  • --offset INTEGER: Rows to skip
  • --pretty / --no-pretty: Pretty-print JSON [default: pretty]
  • --help: Show this message and exit.

meshagent room database optimize

Usage:
$ meshagent room database optimize [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -t, --table TEXT: Table name [required]
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --help: Show this message and exit.

meshagent room database versions

Usage:
$ meshagent room database versions [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -t, --table TEXT: Table name [required]
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --pretty / --no-pretty: Pretty-print JSON [default: pretty]
  • --help: Show this message and exit.

meshagent room database checkout

Usage:
$ meshagent room database checkout [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -t, --table TEXT: Table name [required]
  • -v, --version INTEGER: Table version [required]
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --help: Show this message and exit.

meshagent room database restore

Usage:
$ meshagent room database restore [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -t, --table TEXT: Table name [required]
  • -v, --version INTEGER: Table version [required]
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --help: Show this message and exit.

meshagent room database indexes

Usage:
$ meshagent room database indexes [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -t, --table TEXT: Table name [required]
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --pretty / --no-pretty: Pretty-print JSON [default: pretty]
  • --help: Show this message and exit.

meshagent room database index-create

Usage:
$ meshagent room database index-create [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -t, --table TEXT: Table name [required]
  • -c, --column TEXT: Column name [required]
  • --kind TEXT: vector | scalar | fts [default: scalar]
  • --replace / --no-replace: Replace existing index if it already exists
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --help: Show this message and exit.

meshagent room database index-drop

Usage:
$ meshagent room database index-drop [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -t, --table TEXT: Table name [required]
  • --name TEXT: Index name [required]
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --help: Show this message and exit.

meshagent room container

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

meshagent room container ps

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

meshagent room container stop

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

meshagent room container logs

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

meshagent room container exec

Usage:
$ meshagent room container exec [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --container-id TEXT: container id [required]
  • --command TEXT: Command to execute in the container (quoted string)
  • --tty / --no-tty: Allocate a TTY [default: no-tty]
  • --help: Show this message and exit.

meshagent room container run

Usage:
$ meshagent room container run [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --image TEXT: Image to run [required]
  • --command TEXT: Command to execute in the container (quoted string)
  • -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: Room storage path to mount into the container
  • --mount-subpath TEXT: Subpath within --mount-path to mount
  • --participant-name TEXT: Participant name to associate with the run
  • --role TEXT: Role to run the container as [default: user]
  • --container-name TEXT: Optional container name
  • --help: Show this message and exit.

meshagent room container images

Image operations Usage:
$ meshagent room container images [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • list
  • delete
  • pull
meshagent room container images list
Usage:
$ meshagent room container images list [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --help: Show this message and exit.
meshagent room container images delete
Usage:
$ meshagent room container images delete [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --image TEXT: Image ref/tag to delete [required]
  • --help: Show this message and exit.
meshagent room container images pull
Usage:
$ meshagent room container images pull [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --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 room sync

Inspect and update mesh documents in a room Usage:
$ meshagent room sync [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • show: Print the full document JSON
  • grep: Search the document for matching content
  • inspect: Print the document schema JSON
  • create: Create a new document at a path
  • update: Apply a JSON patch to a document

meshagent room sync show

Print the full document JSON Usage:
$ meshagent room sync show [OPTIONS] PATH
Arguments:
  • PATH: [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --include-ids: Include $id attributes in output
  • --pretty / --compact: Pretty-print JSON [default: pretty]
  • --help: Show this message and exit.

meshagent room sync grep

Search the document for matching content Usage:
$ meshagent room sync grep [OPTIONS] PATH PATTERN
Arguments:
  • PATH: [required]
  • PATTERN: Regex pattern to match [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --ignore-case: Ignore case
  • --before INTEGER RANGE: Include siblings before [default: 0; x>=0]
  • --after INTEGER RANGE: Include siblings after [default: 0; x>=0]
  • --include-ids: Include $id attributes in output
  • --pretty / --compact: Pretty-print JSON [default: pretty]
  • --help: Show this message and exit.

meshagent room sync inspect

Print the document schema JSON Usage:
$ meshagent room sync inspect [OPTIONS] PATH
Arguments:
  • PATH: [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --pretty / --compact: Pretty-print JSON [default: pretty]
  • --help: Show this message and exit.

meshagent room sync create

Create a new document at a path Usage:
$ meshagent room sync create [OPTIONS] PATH
Arguments:
  • PATH: [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --schema PATH: Schema JSON file [required]
  • --json TEXT: Initial JSON payload
  • --json-file PATH: Path to initial JSON payload
  • --help: Show this message and exit.

meshagent room sync update

Apply a JSON patch to a document Usage:
$ meshagent room sync update [OPTIONS] PATH
Arguments:
  • PATH: [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --patch TEXT: JSON patch array
  • --patch-file PATH: Path to JSON patch array
  • --help: Show this message and exit.