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
  • secret: Manage secrets for your project.
  • helper: Developer helper services
  • rooms: Create, list, and manage rooms in a project
  • mailbox: Manage mailboxes for your project
  • route: Manage routes for your project
  • scheduled-task: Manage scheduled tasks 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
  • process: Join a process-backed agent to a room
  • room: Operate within a room
  • image: Build and pack OCI images

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: Create a new MeshAgent project.
  • list: List projects and mark the currently…
  • activate: Set the active project for subsequent CLI…

meshagent project create

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

meshagent project list

List projects and mark the currently active one. Usage:
$ meshagent project list [OPTIONS]
Options:
  • -o, --output TEXT: output format [default: table]
  • --help: Show this message and exit.

meshagent project activate

Set the active project for subsequent CLI commands. 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: List API keys for a project.
  • create: Create a new API key for a project.
  • activate: Set the default API key for a project in…
  • delete: Delete an API key from a project.

meshagent api-key list

List API keys for a project. 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

Create a new API key for a project. 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

Set the default API key for a project in local CLI settings. 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

Delete an API key from a project. 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:
  • spec: Render a service or template YAML spec…
  • 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.
  • render-template: Render a service template with variables…
  • run: Run a local command and register it as a…
  • show: Show a services for the project.
  • list: List all services for the project.
  • delete: Delete a service.

meshagent service spec

Render a service or template YAML spec without creating a service. Usage:
$ meshagent service spec [OPTIONS]
Options:
  • -f, --file TEXT: File path to a service definition
  • --url TEXT: URL to a service definition
  • --mcp TEXT: MCP server URL. Auto-discovers metadata and generates a service spec without creating it.
  • --format [service|template]: Output format. ‘service’ emits Service YAML. ‘template’ emits ServiceTemplate YAML. [default: service]
  • --service-id TEXT: Optional override for meshagent.service.id in metadata annotations.
  • --help: Show this message and exit.

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
  • --mcp TEXT: MCP server URL. Auto-discovers OAuth metadata and creates an external MCP service configured for dynamic client registration.
  • --room TEXT: Room name
  • --global: Create the service globally instead of in a room
  • --service-id TEXT: Optional override for meshagent.service.id in metadata annotations.
  • --force: Ignore an existing service with the same meshagent.service.id.
  • --replace: Replace an existing service with the same meshagent.service.id.
  • --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
  • --mcp TEXT: MCP server URL. Auto-discovers OAuth metadata and builds an external MCP service configured for dynamic client registration.
  • --create / --no-create: create the service if it does not exist [default: no-create]
  • --room TEXT: Room name
  • --global: Update the global service instead of a room service
  • --service-id TEXT: Optional override for meshagent.service.id in metadata annotations.
  • --force: Ignore an existing service with the same meshagent.service.id.
  • --replace: Replace an existing service with the same meshagent.service.id.
  • --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
  • --global: Create the service globally instead of in a room
  • --force: Ignore an existing service with the same meshagent.service.id.
  • --replace: Replace an existing service with the same meshagent.service.id.
  • --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
  • --global: Update the global service instead of a room service
  • --force: Ignore an existing service with the same meshagent.service.id.
  • --replace: Replace an existing service with the same meshagent.service.id.
  • --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
  • --url TEXT: URL to a service template
  • --values-file TEXT: File path to template values
  • -v, --value TEXT: Template value override (key=value)
  • --help: Show this message and exit.

meshagent service render-template

Render a service template with variables and print the rendered YAML. Usage:
$ meshagent service render-template [OPTIONS]
Options:
  • -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)
  • --help: Show this message and exit.

meshagent service run

Run a local command and register it as a temporary room service. 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:FORMAT). FORMAT uses secret placeholders, e.g. Header:Bearer {my_secret}
  • --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:FORMAT). FORMAT uses secret placeholders, e.g. Header:Bearer {my_secret}
  • --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 secret

Manage secrets for your project. Usage:
$ meshagent secret [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • list: List all secrets in the project (typed as…
  • delete: Delete a secret.
  • key: Create or update environment-based…
  • keys: Create or update environment-based…
  • docker: Create or update a Docker registry pull…
  • acr: Create or update an Azure Container…
  • gar: Create or update a Google Artifact…

meshagent secret list

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

meshagent secret delete

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

meshagent secret key

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

meshagent secret key create

Create a new ‘keys’ secret (opaque env-vars). Usage:
$ meshagent secret key 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 secret key update

Update an existing ‘keys’ secret (opaque env-vars). Usage:
$ meshagent secret key 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 secret keys

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

meshagent secret keys create

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

meshagent secret keys update

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

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

meshagent secret docker create

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

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

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

meshagent secret acr create

Create a new ACR pull secret (defaults email to ‘none@microsoft.com’). Usage:
$ meshagent secret acr create [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --name TEXT: Secret name [required]
  • --server TEXT: ACR server, e.g. myregistry.azurecr.io [required]
  • --username TEXT: Service principal ID [required]
  • --password TEXT: Service principal secret/password [required]
  • --help: Show this message and exit.

meshagent secret acr update

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

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

meshagent secret gar create

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

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

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

meshagent helper service

Run local helper HTTP services Usage:
$ meshagent helper 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
  • --annotations TEXT: Optional JSON object for room annotations, e.g. {“meshagent.storage.class”:“ephemeral”}
  • --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]
  • --annotations TEXT: Optional JSON object for room annotations, e.g. {“meshagent.storage.class”:“ephemeral”}
  • --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
  • -n, --annotations TEXT: annotations in json format {“name”:“value”}
  • --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
  • -n, --annotations TEXT: annotations in json format {“name”:“value”}
  • --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 route

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

meshagent route create

Create a route attached to the project. Usage:
$ meshagent route create [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • -d, --domain TEXT: Domain name to route (unique per project) [required]
  • --room TEXT: Room name
  • -p, --port TEXT: Published port to route to [required]
  • -n, --annotations TEXT: annotations in json format {“name”:“value”}
  • --help: Show this message and exit.

meshagent route update

Update a route configuration. Usage:
$ meshagent route update [OPTIONS] DOMAIN
Arguments:
  • DOMAIN: Domain name 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 traffic into
  • -p, --port TEXT: Published port to route to
  • -n, --annotations TEXT: annotations in json format {“name”:“value”}
  • --help: Show this message and exit.

meshagent route show

Show route details. Usage:
$ meshagent route show [OPTIONS] DOMAIN
Arguments:
  • DOMAIN: Domain name 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 route list

List routes for the project. Usage:
$ meshagent route 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 route delete

Delete a route. Usage:
$ meshagent route delete [OPTIONS] DOMAIN
Arguments:
  • DOMAIN: Domain name 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 scheduled-task

Manage scheduled tasks for your project Usage:
$ meshagent scheduled-task [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • add: Add a scheduled task.
  • list: List scheduled tasks.
  • update: Update a scheduled task.
  • delete: Delete a scheduled task.

meshagent scheduled-task add

Add a scheduled task. Usage:
$ meshagent scheduled-task add [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • -r, --room TEXT: Room name
  • -q, --queue TEXT: Queue name to dispatch the task to [required]
  • -s, --schedule TEXT: Cron schedule for task execution [required]
  • --payload TEXT: JSON payload to enqueue (for example ’{“action”:“sync”}’)
  • --payload-file TEXT: Path to a file containing JSON payload
  • --id TEXT: Optional task id
  • --once: Run once and then deactivate
  • --active / --inactive: Initial active state [default: active]
  • -n, --annotations TEXT: annotations in json format {“name”:“value”}
  • --help: Show this message and exit.

meshagent scheduled-task list

List scheduled tasks. Usage:
$ meshagent scheduled-task list [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • -r, --room TEXT: Filter by room name
  • --id, --task-id TEXT: Filter by scheduled task id
  • --active: Filter to active tasks only
  • --inactive: Filter to inactive tasks only
  • --limit INTEGER: Maximum number of tasks to return [default: 200]
  • --offset INTEGER: Row offset for pagination [default: 0]
  • -o, --output TEXT: output format [default: table]
  • --help: Show this message and exit.

meshagent scheduled-task update

Update a scheduled task. Usage:
$ meshagent scheduled-task update [OPTIONS] TASK_ID
Arguments:
  • TASK_ID: Scheduled task id to update [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • -r, --room TEXT: Updated room name
  • -q, --queue TEXT: Updated queue name
  • -s, --schedule TEXT: Updated cron schedule
  • --payload TEXT: Updated JSON payload to enqueue (for example ’{“action”:“sync”}’)
  • --payload-file TEXT: Path to a file containing updated JSON payload
  • --active: Mark the task active
  • --inactive: Mark the task inactive
  • -n, --annotations TEXT: annotations in json format {“name”:“value”}
  • --help: Show this message and exit.

meshagent scheduled-task delete

Delete a scheduled task. Usage:
$ meshagent scheduled-task delete [OPTIONS] TASK_ID
Arguments:
  • TASK_ID: Scheduled task id 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: Join a room and run the meeting…
  • service

meshagent meeting-transcriber join

Join a room and run the meeting transcriber agent. 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]
  • -n, --name TEXT: Container name to port-forward into
  • -c, --container-id TEXT: Container ID to port-forward into
  • -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: Generate a combined service spec from…
  • deploy: Deploy a combined service from multiple…
  • service
  • join: Run multiple join commands together in one…

meshagent multi spec

Generate a combined service spec from multiple subcommands. 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 …; webserver …; python path-to-python-file.py —name=NameOfModule; chatbot, worker, mailbot, voicebot, and webserver command arguments mirror those of the respective meshagent chatbot service, meshagent worker service, meshagent mailbot service, meshagent voicebot service, and meshagent webserver service commands. [required]
  • --service-name TEXT: service name [required]
  • --agent-name TEXT: identity for injected MESHAGENT_TOKEN [required]
  • --service-description TEXT: service description
  • --service-title TEXT: a display name for the service
  • --help: Show this message and exit.

meshagent multi deploy

Deploy a combined service from multiple subcommands. 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 …; webserver …; python path-to-python-file.py —name=NameOfModule; chatbot, worker, mailbot, voicebot, and webserver command arguments mirror those of the respective meshagent chatbot service, meshagent worker service, meshagent mailbot service, meshagent voicebot service, and meshagent webserver service commands. [required]
  • --service-name TEXT: service name [required]
  • --agent-name TEXT: identity for injected MESHAGENT_TOKEN [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 …; webserver …; python path-to-python-file.py —name=NameOfModule; chatbot, worker, mailbot, voicebot, and webserver command arguments mirror those of the respective meshagent chatbot service, meshagent worker service, meshagent mailbot service, meshagent voicebot service, and meshagent webserver service commands.
  • --help: Show this message and exit.

meshagent multi join

Run multiple join commands together in one process. 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 …; webserver …; python path-to-python-file.py —name=NameOfModule; chatbot, worker, mailbot, voicebot, and webserver command arguments mirror those of the respective meshagent chatbot service, meshagent worker service, meshagent mailbot service, meshagent voicebot service, and meshagent webserver 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
  • --agent-name TEXT: Name of the agent to call
  • --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: Join a room and run a voicebot agent.
  • service
  • spec: Generate a service spec for deploying a…
  • deploy: Deploy a voicebot service to a project or…

meshagent voicebot join

Join a room and run a voicebot agent. 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
  • --token-from-env TEXT: Name of environment variable containing a MeshAgent token
  • -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
  • --voice TEXT: OpenAI Realtime voice preset to use
  • --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
  • --voice TEXT: OpenAI Realtime voice preset to use
  • --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

Generate a service spec for deploying a voicebot. Usage:
$ meshagent voicebot spec [OPTIONS]
Options:
  • --service-name TEXT: service name
  • --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
  • --voice TEXT: OpenAI Realtime voice preset to use
  • -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

Deploy a voicebot service to a project or room. Usage:
$ meshagent voicebot deploy [OPTIONS]
Options:
  • --service-name TEXT: service name
  • --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
  • --voice TEXT: OpenAI Realtime voice preset to use
  • -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 process

Join a process-backed agent to a room Usage:
$ meshagent process [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • join: Join a room and run a process-backed agent.
  • service: Add a process-backed agent service to the…
  • spec: Generate a service spec for deploying a…
  • deploy: Deploy a process-backed agent service.
  • run: Join a room, run a process-backed agent,…
  • use: Send a one-shot or interactive message to…

meshagent process join

Join a room and run a process-backed agent. Usage:
$ meshagent process 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
  • --token-from-env TEXT: Name of environment variable containing a MeshAgent token
  • -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.4]
  • --image-generation TEXT: Name of an image gen model
  • --computer-use / --no-computer-use: Enable computer use [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]
  • --shell-room-mount TEXT: Mount room storage as <source>:<mount>[:ro|rw]
  • --shell-project-mount TEXT: Mount project storage as <source>:<mount>[:ro|rw]
  • --shell-empty-dir-mount TEXT: Mount empty dir at <mount>[:ro|rw]
  • --shell-image-mount TEXT: Mount image as <image>=<mount>[:ro|rw]
  • --require-image-generation TEXT: Name of an image gen model
  • --starting-url TEXT: Initial URL to open when starting a computer-use browser session
  • --allow-goto-url: Expose the goto URL helper tool for computer use
  • --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-advanced-shell: Enable the managed container toolkit with start/list/stop/run tools.
  • --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]
  • --use-memory TEXT: Use memories toolkit for <name> or <namespace>/<name>
  • --memory-model TEXT: Model name for memory LLM ingestion
  • --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-dir 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
  • --decision-model TEXT: Model used for thread naming and other secondary LLM decisions
  • --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
  • --threading-mode [none|default-new]: Threading mode for thread UIs. Use ‘default-new’ to show a new-thread composer before loading a thread. [default: none]
  • --thread-dir TEXT: Thread directory for agent thread files. Defaults to .threads/<agent-name> when not provided.
  • --channel TEXT: Attach a channel to the agent process. Can be repeated. Currently supported: chat, mail:EMAIL_ADDRESS, queue:QUEUE_NAME, toolkit:NAME.
  • --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]
  • --shell-copy-env TEXT: Copy local env vars into shell tool env. Accepts comma-separated names and can be repeated.
  • --shell-set-env TEXT: Set env vars in shell tool env as NAME=VALUE. Can be repeated.
  • --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 process service

Add a process-backed agent service to the host. Usage:
$ meshagent process 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.4]
  • --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 [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]
  • --shell-room-mount TEXT: Mount room storage as <source>:<mount>[:ro|rw]
  • --shell-project-mount TEXT: Mount project storage as <source>:<mount>[:ro|rw]
  • --shell-empty-dir-mount TEXT: Mount empty dir at <mount>[:ro|rw]
  • --shell-image-mount TEXT: Mount image as <image>=<mount>[:ro|rw]
  • --require-image-generation TEXT: Name of an image gen model
  • --starting-url TEXT: Initial URL to open when starting a computer-use browser session
  • --allow-goto-url: Expose the goto URL helper tool for computer use
  • --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-advanced-shell: Enable the managed container toolkit with start/list/stop/run tools.
  • --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]
  • --use-memory TEXT: Use memories toolkit for <name> or <namespace>/<name>
  • --memory-model TEXT: Model name for memory LLM ingestion
  • --working-dir 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
  • --decision-model TEXT: Model used for thread naming and other secondary LLM decisions
  • --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
  • --threading-mode [none|default-new]: Threading mode for thread UIs. Use ‘default-new’ to show a new-thread composer before loading a thread. [default: none]
  • --thread-dir TEXT: Thread directory for agent thread files. Defaults to .threads/<agent-name> when not provided.
  • --channel TEXT: Attach a channel to the agent process. Can be repeated. Currently supported: chat, mail:EMAIL_ADDRESS, queue:QUEUE_NAME, toolkit:NAME.
  • --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]
  • --shell-copy-env TEXT: Copy local env vars into shell tool env. Accepts comma-separated names and can be repeated.
  • --shell-set-env TEXT: Set env vars in shell tool env as NAME=VALUE. Can be repeated.
  • --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 process spec

Generate a service spec for deploying a process-backed agent. Usage:
$ meshagent process spec [OPTIONS]
Options:
  • --service-name TEXT: service name
  • --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.4]
  • --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 [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]
  • --shell-room-mount TEXT: Mount room storage as <source>:<mount>[:ro|rw]
  • --shell-project-mount TEXT: Mount project storage as <source>:<mount>[:ro|rw]
  • --shell-empty-dir-mount TEXT: Mount empty dir at <mount>[:ro|rw]
  • --require-image-generation TEXT: Name of an image gen model
  • --starting-url TEXT: Initial URL to open when starting a computer-use browser session
  • --allow-goto-url: Expose the goto URL helper tool for computer use
  • --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-advanced-shell: Enable the managed container toolkit with start/list/stop/run tools.
  • --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]
  • --use-memory TEXT: Use memories toolkit for <name> or <namespace>/<name>
  • --memory-model TEXT: Model name for memory LLM ingestion
  • --working-dir 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
  • --decision-model TEXT: Model used for thread naming and other secondary LLM decisions
  • --always-reply / --no-always-reply: Always reply
  • --threading-mode [none|default-new]: Threading mode for thread UIs. Use ‘default-new’ to show a new-thread composer before loading a thread. [default: none]
  • --thread-dir TEXT: Thread directory for agent thread files. Defaults to .threads/<agent-name> when not provided.
  • --channel TEXT: Attach a channel to the agent process. Can be repeated. Currently supported: chat, mail:EMAIL_ADDRESS, queue:QUEUE_NAME, toolkit:NAME.
  • --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]
  • --shell-copy-env TEXT: Copy local env vars into shell tool env. Accepts comma-separated names and can be repeated.
  • --shell-set-env TEXT: Set env vars in shell tool env as NAME=VALUE. Can be repeated.
  • --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 process deploy

Deploy a process-backed agent service. Usage:
$ meshagent process deploy [OPTIONS]
Options:
  • --service-name TEXT: service name
  • --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.4]
  • --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 [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]
  • --shell-room-mount TEXT: Mount room storage as <source>:<mount>[:ro|rw]
  • --shell-project-mount TEXT: Mount project storage as <source>:<mount>[:ro|rw]
  • --shell-empty-dir-mount TEXT: Mount empty dir at <mount>[:ro|rw]
  • --require-image-generation TEXT: Name of an image gen model
  • --starting-url TEXT: Initial URL to open when starting a computer-use browser session
  • --allow-goto-url: Expose the goto URL helper tool for computer use
  • --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-advanced-shell: Enable the managed container toolkit with start/list/stop/run tools.
  • --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]
  • --use-memory TEXT: Use memories toolkit for <name> or <namespace>/<name>
  • --memory-model TEXT: Model name for memory LLM ingestion
  • --working-dir 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
  • --decision-model TEXT: Model used for thread naming and other secondary LLM decisions
  • --always-reply / --no-always-reply: Always reply
  • --threading-mode [none|default-new]: Threading mode for thread UIs. Use ‘default-new’ to show a new-thread composer before loading a thread. [default: none]
  • --thread-dir TEXT: Thread directory for agent thread files. Defaults to .threads/<agent-name> when not provided.
  • --channel TEXT: Attach a channel to the agent process. Can be repeated. Currently supported: chat, mail:EMAIL_ADDRESS, queue:QUEUE_NAME, toolkit:NAME.
  • --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]
  • --shell-copy-env TEXT: Copy local env vars into shell tool env. Accepts comma-separated names and can be repeated.
  • --shell-set-env TEXT: Set env vars in shell tool env as NAME=VALUE. Can be repeated.
  • --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 process run

Join a room, run a process-backed agent, and wait for messages. Usage:
$ meshagent process 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.4]
  • --image-generation TEXT: Name of an image gen model
  • --computer-use / --no-computer-use: Enable computer use [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]
  • --shell-room-mount TEXT: Mount room storage as <source>:<mount>[:ro|rw]
  • --shell-project-mount TEXT: Mount project storage as <source>:<mount>[:ro|rw]
  • --shell-empty-dir-mount TEXT: Mount empty dir at <mount>[:ro|rw]
  • --require-image-generation TEXT: Name of an image gen model
  • --starting-url TEXT: Initial URL to open when starting a computer-use browser session
  • --allow-goto-url: Expose the goto URL helper tool for computer use
  • --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-advanced-shell: Enable the managed container toolkit with start/list/stop/run tools.
  • --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]
  • --use-memory TEXT: Use memories toolkit for <name> or <namespace>/<name>
  • --memory-model TEXT: Model name for memory LLM ingestion
  • --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-dir 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
  • --decision-model TEXT: Model used for thread naming and other secondary LLM decisions
  • --always-reply / --no-always-reply: Always reply
  • --threading-mode [none|default-new]: Threading mode for thread UIs. Use ‘default-new’ to show a new-thread composer before loading a thread. [default: none]
  • --thread-dir TEXT: Thread directory for agent thread files. Defaults to .threads/<agent-name> when not provided.
  • --channel TEXT: Attach a channel to the agent process. Can be repeated. Currently supported: chat, mail:EMAIL_ADDRESS, queue:QUEUE_NAME, toolkit:NAME.
  • --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]
  • --shell-copy-env TEXT: Copy local env vars into shell tool env. Accepts comma-separated names and can be repeated.
  • --shell-set-env TEXT: Set env vars in shell tool env as NAME=VALUE. Can be repeated.
  • --log-llm-requests / --no-log-llm-requests: log all requests to the llm [default: no-log-llm-requests]
  • --verbose: Enable verbose logging and disable default log suppression
  • --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 process use

Send a one-shot or interactive message to a running process-backed agent. Usage:
$ meshagent process 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 room

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

meshagent room agent

Interact with agents and toolkits Usage:
$ meshagent room agent [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 agent invoke-tool

Invoke a specific tool from a toolkit Usage:
$ meshagent room agent 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 agent list-toolkits

List toolkits (and tools) available in the room Usage:
$ meshagent room agent 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 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 secret

Manage secrets in a room Usage:
$ meshagent room secret [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • oauth: Request an OAuth token from another…
  • request: Request a secret from another participant.
  • get: Fetch a stored secret by ID.
  • set: Store a secret by ID.
  • list: List secrets in the room.
  • delete: Delete a secret by ID.

meshagent room secret oauth

Request an OAuth token from another participant. Usage:
$ meshagent room secret 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 secret request

Request a secret from another participant. Usage:
$ meshagent room secret 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 secret get

Fetch a stored secret by ID. Usage:
$ meshagent room secret get [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: 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 secret set

Store a secret by ID. Usage:
$ meshagent room secret set [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: 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 secret list

List secrets in the room. Usage:
$ meshagent room secret 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 secret delete

Delete a secret by ID. Usage:
$ meshagent room secret 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 secrets

Manage secrets in a room Usage:
$ meshagent room secrets [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • oauth: Request an OAuth token from another…
  • request: Request a secret from another participant.
  • get: Fetch a stored secret by ID.
  • set: Store a secret by ID.
  • list: List secrets in the room.
  • delete: Delete a secret by ID.

meshagent room secrets oauth

Request an OAuth token from another participant. 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

Fetch a stored secret by 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]
  • --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

Store a secret by ID. 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]
  • --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 in the room. 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 by ID. 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:
  • list: List queues in a room.
  • send: Send a JSON message to a room queue.
  • send-mail: Create an email message and send it to a…
  • receive: Receive a message from a room queue.
  • size: Show the current size of a room queue.

meshagent room queue list

List queues in a room. Usage:
$ meshagent room queue 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 queue send

Send a JSON message to a room queue. 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 send-mail

Create an email message and send it to a room queue. Usage:
$ meshagent room queue send-mail [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]
  • --subject TEXT: Email subject [required]
  • --body TEXT: Email body
  • --from TEXT: Sender email address [required]
  • --attachment TEXT: Attachment file path. May be provided multiple times.
  • --help: Show this message and exit.

meshagent room queue receive

Receive a message from a room queue. 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 queue size

Show the current size of a room queue. Usage:
$ meshagent room queue size [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 whether a path exists in room storage.
  • cp: Copy files between local paths and room…
  • show: Print file contents from local disk or…
  • rm: Remove files or directories from local…
  • ls: List files and directories locally or in…

meshagent room storage exists

Check whether a path exists in room 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

Copy files between local paths and room storage. 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 file contents from local disk or room storage. 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 or directories from local disk or room storage. 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 and directories locally or in room storage. 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 service

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

meshagent room service list

List services running in a room Usage:
$ meshagent room service 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 service restart

Restart a running room service by stopping its current container. Usage:
$ meshagent room service restart [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: Service ID to restart
  • --name TEXT: Service name to restart
  • --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
  • restart: Restart a running room service by stopping…

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 services restart

Restart a running room service by stopping its current container. Usage:
$ meshagent room services restart [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: Service ID to restart
  • --name TEXT: Service name to restart
  • --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]
  • --format [plain|json]: Output format [default: plain]
  • --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:
  • table: List database tables in a room.
  • tables: List database tables in a room.
  • inspect: Inspect a table schema in a room database.
  • install: Install required tables from a…
  • create: Create a room database table with optional…
  • drop: Drop a room database table.
  • add-columns: Add columns to a room database table.
  • drop-columns: Drop columns from a room database table.
  • insert: Insert records into a room database table.
  • merge: Upsert records into a room database table.
  • update: Update rows in a room database table.
  • delete: Delete rows from a room database table.
  • search: Search rows in a room database table.
  • sql: Execute SQL against room database tables.
  • optimize: Optimize a room database table.
  • version: List versions for a room database table.
  • versions: List versions for a room database table.
  • checkout: Check out a room database table at a…
  • restore: Restore a room database table to a…
  • index: List indexes on a room database table.
  • indexes: List indexes on a room database table.
  • index-create: Create an index on a room database table.
  • index-drop: Drop an index from a room database table.

meshagent room database table

List database tables in a room. Usage:
$ meshagent room database table [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 tables

List database tables in a room. 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

Inspect a table schema in a room database. 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

Install required tables from a requirements JSON file. 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 room database table with optional schema and seed data. 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, tags list(text), meta struct(owner text, score float)”. Allowed types: int, bool, date, timestamp, float, text, binary, vector, list, struct. Vector syntax: vector(size[, element_type]). List syntax: list(element_type). Struct syntax: struct(field_name 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

Drop a room database table. 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 to a room database table. 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, tags list(text), meta struct(owner text, score float)”. Allowed types: int, bool, date, timestamp, float, text, binary, vector, list, struct. Vector syntax: vector(size[, element_type]). List syntax: list(element_type). Struct syntax: struct(field_name type[, …]).
  • --columns-json TEXT: JSON object of new columns. Supports DataType JSON including list/struct (e.g. ’{“meta”:{“type”:“struct”,“fields”:{“owner”:{“type”:“text”}}}}’).
  • --help: Show this message and exit.

meshagent room database drop-columns

Drop columns from a room database table. 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

Insert records into a room database table. 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

Upsert records into a room database table. 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

Update rows in a room database table. 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

Delete rows from a room database table. 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.
Search rows in a room database table. 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 sql

Execute SQL against room database tables. Usage:
$ meshagent room database sql [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -q, --query TEXT: SQL query to execute [required]
  • -t, --table TEXT: Table name to register in SQL context (repeatable)
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --tables-json TEXT: JSON array of table refs (e.g. ’[{“name”:“users”,“alias”:“u”,“namespace”:[“prod”]}]’)
  • --tables-file TEXT: Path/URL to JSON array of table refs (same format as —tables-json)
  • --params-json TEXT: JSON object of SQL parameters for DataFusion param binding
  • --params-file TEXT: Path/URL to JSON object of SQL parameters
  • --pretty / --no-pretty: Pretty-print JSON [default: pretty]
  • --help: Show this message and exit.

meshagent room database optimize

Optimize a room database table. 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 version

List versions for a room database table. Usage:
$ meshagent room database version [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 versions

List versions for a room database table. 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

Check out a room database table at a specific version. 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

Restore a room database table to a specific version. 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 index

List indexes on a room database table. Usage:
$ meshagent room database index [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 indexes

List indexes on a room database table. 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

Create an index on a room database table. 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

Drop an index from a room database table. 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 memory

Manage memories in a room Usage:
$ meshagent room memory [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • list: List memories in a room namespace.
  • create: Create a room memory store.
  • drop: Drop a room memory store.
  • inspect: Inspect metadata and datasets for a memory.
  • query: Run a SQL-like query against memory datasets.
  • upsert-table: Upsert records from JSON into memory tables.
  • upsert-nodes: Upsert entity nodes into memory.
  • upsert-relationships: Upsert relationship edges into memory.
  • import: Import entities and relationships from a…
  • ingest-text: Extract memory from input text.
  • ingest-image: Extract memory from an image.
  • ingest-file: Extract memory from local file/text content.
  • ingest-from-table: Extract memory from table rows.
  • ingest-from-storage: Extract memory from room storage paths.
  • recall: Recall entities and relationships from…
  • delete-entities: Delete entities (and related edges) from…
  • delete-relationships: Delete relationship edges from memory.
  • optimize: Optimize memory datasets.

meshagent room memory list

List memories in a room namespace. Usage:
$ meshagent room memory list [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
  • --pretty / --no-pretty: Pretty-print JSON [default: pretty]
  • --help: Show this message and exit.

meshagent room memory create

Create a room memory store. Usage:
$ meshagent room memory create [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -m, --name TEXT: Memory name [required]
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --overwrite: Overwrite existing memory
  • --help: Show this message and exit.

meshagent room memory drop

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

meshagent room memory inspect

Inspect metadata and datasets for a memory. Usage:
$ meshagent room memory inspect [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -m, --name TEXT: Memory 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 memory query

Run a SQL-like query against memory datasets. Usage:
$ meshagent room memory query [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -m, --name TEXT: Memory name [required]
  • -s, --statement TEXT: Statement, e.g. “MATCH (e:Entity) RETURN e.name LIMIT 10” [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 memory upsert-table

Upsert records from JSON into memory tables. Usage:
$ meshagent room memory upsert-table [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -m, --name TEXT: Memory name [required]
  • -t, --table TEXT: Table name [required]
  • --records-json TEXT: JSON array of records
  • --records-file TEXT: Path to JSON file with records
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --merge / --no-merge: Merge with existing records [default: merge]
  • --help: Show this message and exit.

meshagent room memory upsert-nodes

Upsert entity nodes into memory. Usage:
$ meshagent room memory upsert-nodes [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -m, --name TEXT: Memory name [required]
  • --records-json TEXT: JSON array of MemoryEntityRecord objects
  • --records-file TEXT: Path to JSON file with entity records
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --merge / --no-merge: Merge with existing nodes [default: merge]
  • --help: Show this message and exit.

meshagent room memory upsert-relationships

Upsert relationship edges into memory. Usage:
$ meshagent room memory upsert-relationships [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -m, --name TEXT: Memory name [required]
  • --records-json TEXT: JSON array of MemoryRelationshipRecord objects
  • --records-file TEXT: Path to JSON file with relationship records
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --merge / --no-merge: Merge with existing relationships [default: merge]
  • --help: Show this message and exit.

meshagent room memory import

Import entities and relationships from a FalkorDB dump.rdb file. Usage:
$ meshagent room memory import [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -m, --name TEXT: Memory name [required]
  • -f, --rdb-file PATH: Path to FalkorDB dump.rdb file [required]
  • --graph-name TEXT: FalkorDB graph key name. Auto-detected when unambiguous.
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --merge / --no-merge: Merge with existing records [default: merge]
  • --batch-size INTEGER RANGE: Rows per GRAPH.QUERY batch while importing [default: 250; x>=1]
  • --docker-image TEXT: Docker image to use for temporary FalkorDB container [default: falkordb/falkordb:latest]
  • --startup-timeout-seconds FLOAT RANGE: Max seconds to wait for FalkorDB startup [default: 30.0; x>=1.0]
  • --create-memory / --no-create-memory: Create the target memory when missing [default: create-memory]
  • --help: Show this message and exit.

meshagent room memory ingest-text

Extract memory from input text. Usage:
$ meshagent room memory ingest-text [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -m, --name TEXT: Memory name [required]
  • --text TEXT: Text content to ingest
  • -f, --file TEXT: Path to UTF-8 text file
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --strategy [heuristic|llm]: Ingest strategy: heuristic or llm [default: heuristic]
  • --llm-model TEXT: Model name for llm strategy
  • --llm-temperature FLOAT: Temperature for llm strategy
  • --pretty / --no-pretty: Pretty-print JSON [default: pretty]
  • --help: Show this message and exit.

meshagent room memory ingest-image

Extract memory from an image. Usage:
$ meshagent room memory ingest-image [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -m, --name TEXT: Memory name [required]
  • -f, --file TEXT: Path to image file
  • --caption TEXT: Optional image caption
  • --mime-type TEXT: Image mime type
  • --source TEXT: Source identifier/path
  • --annotations-json TEXT: Optional JSON map of string annotations, e.g. {“origin”:“camera”}
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --strategy [heuristic|llm]: Ingest strategy: heuristic or llm [default: heuristic]
  • --llm-model TEXT: Model name for llm strategy
  • --llm-temperature FLOAT: Temperature for llm strategy
  • --pretty / --no-pretty: Pretty-print JSON [default: pretty]
  • --help: Show this message and exit.

meshagent room memory ingest-file

Extract memory from local file/text content. Usage:
$ meshagent room memory ingest-file [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -m, --name TEXT: Memory name [required]
  • --path TEXT: File path available to the room server
  • --text TEXT: Inline text content
  • --text-file TEXT: Path to local UTF-8 text file
  • --mime-type TEXT: Optional mime type
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --strategy [heuristic|llm]: Ingest strategy: heuristic or llm [default: heuristic]
  • --llm-model TEXT: Model name for llm strategy
  • --llm-temperature FLOAT: Temperature for llm strategy
  • --pretty / --no-pretty: Pretty-print JSON [default: pretty]
  • --help: Show this message and exit.

meshagent room memory ingest-from-table

Extract memory from table rows. Usage:
$ meshagent room memory ingest-from-table [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -m, --name TEXT: Memory name [required]
  • -t, --table TEXT: Source table name [required]
  • --text-column TEXT: Source text columns (repeatable)
  • --table-namespace TEXT: Namespace path segments for the source table (repeatable)
  • --limit INTEGER: Maximum source rows
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --strategy [heuristic|llm]: Ingest strategy: heuristic or llm [default: heuristic]
  • --llm-model TEXT: Model name for llm strategy
  • --llm-temperature FLOAT: Temperature for llm strategy
  • --pretty / --no-pretty: Pretty-print JSON [default: pretty]
  • --help: Show this message and exit.

meshagent room memory ingest-from-storage

Extract memory from room storage paths. Usage:
$ meshagent room memory ingest-from-storage [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -m, --name TEXT: Memory name [required]
  • -p, --path TEXT: Room storage path to ingest (repeatable) [required]
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --strategy [heuristic|llm]: Ingest strategy: heuristic or llm [default: heuristic]
  • --llm-model TEXT: Model name for llm strategy
  • --llm-temperature FLOAT: Temperature for llm strategy
  • --pretty / --no-pretty: Pretty-print JSON [default: pretty]
  • --help: Show this message and exit.

meshagent room memory recall

Recall entities and relationships from memory. Usage:
$ meshagent room memory recall [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -m, --name TEXT: Memory name [required]
  • -q, --query TEXT: Recall query text [required]
  • --limit INTEGER: Max entities to return [default: 5]
  • --include-relationships / --no-include-relationships: Include related edges for recalled entities [default: include-relationships]
  • -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 memory delete-entities

Delete entities (and related edges) from memory. Usage:
$ meshagent room memory delete-entities [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -m, --name TEXT: Memory name [required]
  • -e, --entity-id TEXT: Entity ID to delete (repeatable) [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 memory delete-relationships

Delete relationship edges from memory. Usage:
$ meshagent room memory delete-relationships [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -m, --name TEXT: Memory name [required]
  • --records-json TEXT: JSON array of MemoryRelationshipSelector objects
  • --records-file TEXT: Path to JSON file with relationship selectors
  • -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 memory optimize

Optimize memory datasets. Usage:
$ meshagent room memory optimize [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -m, --name TEXT: Memory name [required]
  • -n, --namespace TEXT: Namespace path segments (repeatable). Example: -n prod -n analytics
  • --compact / --no-compact: Compact dataset fragments [default: compact]
  • --cleanup / --no-cleanup: Cleanup old dataset versions [default: cleanup]
  • --pretty / --no-pretty: Pretty-print JSON [default: pretty]
  • --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:
  • list: List containers in a room.
  • stop: Stop a running container in a room.
  • log: Print container logs from a room.
  • logs: Print container logs from a room.
  • exec: Execute a command inside a running container.
  • run: Run a container inside a room.
  • image: Image operations
  • images: Image operations

meshagent room container list

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

meshagent room container stop

Stop a running container in a room. 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 log

Print container logs from a room. Usage:
$ meshagent room container log [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 logs

Print container logs from a room. 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

Execute a command inside a running container. 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)
  • --help: Show this message and exit.

meshagent room container run

Run a container inside a room. 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)
  • --working-dir TEXT: Working directory inside the container (must be an absolute path)
  • -e, --env TEXT: KEY=VALUE
  • -p, --port TEXT: CONTAINER:HOST
  • --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 image

Image operations Usage:
$ meshagent room container image [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • list: List container images available in a room.
  • delete: Delete a container image from a room.
  • pull: Pull a container image into a room.
  • push: Push a container image from a room.
  • load: Load an OCI image archive into a room.
  • save: Save an OCI image archive from a room.
meshagent room container image list
List container images available in a room. Usage:
$ meshagent room container image 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 image delete
Delete a container image from a room. Usage:
$ meshagent room container image 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 image pull
Pull a container image into a room. Usage:
$ meshagent room container image 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 container image push
Push a container image from a room. Usage:
$ meshagent room container image push [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 push [required]
  • --private / --public: Whether the push container is private to the participant [default: public]
  • --cred TEXT: Docker creds (username,password) or (registry,username,password)
  • --help: Show this message and exit.
meshagent room container image load
Load an OCI image archive into a room. Usage:
$ meshagent room container image load [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --archive-path TEXT: Path to OCI archive inside one of the mounted paths (absolute path) [required]
  • --mount-room-path TEXT: Room storage mount ‘<source>:<mount>[:ro|rw]’. Example ‘/images:/workspace’
  • --mount-project-path TEXT: Project storage mount ‘<source>:<mount>[:ro|rw]’. Example ‘/shared:/project:ro’
  • --mount-image TEXT: Image mount ‘<image>=<mount>[:ro|rw]’. Example ‘alpine:latest=/toolchain:ro’
  • --private / --public: Whether the load container is private to the participant [default: public]
  • --help: Show this message and exit.
meshagent room container image save
Save an OCI image archive from a room. Usage:
$ meshagent room container image save [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 save [required]
  • --archive-path TEXT: Path to write OCI archive inside one of the mounted paths (absolute path) [required]
  • --mount-room-path TEXT: Room storage mount ‘<source>:<mount>[:ro|rw]’. Example ‘/images:/workspace’
  • --mount-project-path TEXT: Project storage mount ‘<source>:<mount>[:ro|rw]’. Example ‘/shared:/project:ro’
  • --mount-image TEXT: Image mount ‘<image>=<mount>[:ro|rw]’. Example ‘alpine:latest=/toolchain:ro’
  • --private / --public: Whether the save container is private to the participant [default: public]
  • --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: List container images available in a room.
  • delete: Delete a container image from a room.
  • pull: Pull a container image into a room.
  • push: Push a container image from a room.
  • load: Load an OCI image archive into a room.
  • save: Save an OCI image archive from a room.
meshagent room container images list
List container images available in a room. 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
Delete a container image from a room. 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
Pull a container image into a room. 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 container images push
Push a container image from a room. Usage:
$ meshagent room container images push [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 push [required]
  • --private / --public: Whether the push container is private to the participant [default: public]
  • --cred TEXT: Docker creds (username,password) or (registry,username,password)
  • --help: Show this message and exit.
meshagent room container images load
Load an OCI image archive into a room. Usage:
$ meshagent room container images load [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • --archive-path TEXT: Path to OCI archive inside one of the mounted paths (absolute path) [required]
  • --mount-room-path TEXT: Room storage mount ‘<source>:<mount>[:ro|rw]’. Example ‘/images:/workspace’
  • --mount-project-path TEXT: Project storage mount ‘<source>:<mount>[:ro|rw]’. Example ‘/shared:/project:ro’
  • --mount-image TEXT: Image mount ‘<image>=<mount>[:ro|rw]’. Example ‘alpine:latest=/toolchain:ro’
  • --private / --public: Whether the load container is private to the participant [default: public]
  • --help: Show this message and exit.
meshagent room container images save
Save an OCI image archive from a room. Usage:
$ meshagent room container images save [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 save [required]
  • --archive-path TEXT: Path to write OCI archive inside one of the mounted paths (absolute path) [required]
  • --mount-room-path TEXT: Room storage mount ‘<source>:<mount>[:ro|rw]’. Example ‘/images:/workspace’
  • --mount-project-path TEXT: Project storage mount ‘<source>:<mount>[:ro|rw]’. Example ‘/shared:/project:ro’
  • --mount-image TEXT: Image mount ‘<image>=<mount>[:ro|rw]’. Example ‘alpine:latest=/toolchain:ro’
  • --private / --public: Whether the save container is private to the participant [default: public]
  • --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
  • import: Import external exports into room documents

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.

meshagent room sync import

Import external exports into room documents Usage:
$ meshagent room sync import [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • threads: Import Anthropic Claude GDPR conversations…
meshagent room sync import threads
Import Anthropic Claude GDPR conversations into room thread documents. Usage:
$ meshagent room sync import threads [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used. [required]
  • --room TEXT: Room name [required]
  • -f, --file PATH: Path to Claude GDPR conversations.json [required]
  • --thread-dir TEXT: Directory where imported .thread files will be stored [default: .threads/anthropic]
  • --overwrite: Overwrite existing imported thread files
  • --limit INTEGER RANGE: Maximum number of conversations to import [x>=1]
  • --user-name, --human-name TEXT: Author name used for user/human messages [default: human]
  • --assistant-name TEXT: Author name used for assistant messages [default: assistant]
  • --include-empty-messages: Include messages that normalize to empty text
  • --help: Show this message and exit.

meshagent image

Build and pack OCI images Usage:
$ meshagent image [OPTIONS] COMMAND [ARGS]...
Options:
  • --help: Show this message and exit.
Commands:
  • build: Build a container image inside a room.
  • deploy: Create or update a room service from an…
  • pack: Pack a local directory into an OCI image…

meshagent image build

Build a container image inside a room. Usage:
$ meshagent image build [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name
  • --tag TEXT: Image tag to build, e.g. repo/name:tag. When —pack is used, this must start with room.meshagent.com/. [required]
  • --context-path TEXT: Build context path inside one of the mounted paths (absolute path). Defaults to the mounted path when there is exactly one context source.
  • --dockerfile-path TEXT: Optional Dockerfile path inside one of the mounted paths (absolute path)
  • --pack TEXT: Pack a local directory, upload it to room storage, and mount it as an image volume. Format ‘<path>[:<mount>]’. Defaults mount to /context.
  • --arch TEXT: Architecture metadata for the packed build context image. Defaults to amd64 for room runtimes. [default: amd64]
  • --pack-room-path TEXT: Room storage path for the uploaded packed archive. Defaults to a temporary path under /temp/build/packs/ that is deleted after the build completes. If a directory is provided, the repository path from —tag is appended.
  • --mount-room-path TEXT: Room storage mount ‘<source>[:<mount>[:ro|rw]]’. If mount is omitted, /context is used.
  • --mount-project-path TEXT: Project storage mount ‘<source>[:<mount>[:ro|rw]]’. If mount is omitted, /context is used.
  • --mount-image TEXT: Image mount ‘<image>[=<mount>[:ro|rw]]’. If mount is omitted, /context is used.
  • --private / --public: Whether the build container is private to the participant [default: public]
  • --cred TEXT: Docker creds (username,password) or (registry,username,password)
  • --help: Show this message and exit.

meshagent image deploy

Create or update a room service from an image. Usage:
$ meshagent image deploy [OPTIONS]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name
  • --tag TEXT: Image tag to deploy, e.g. repo/name:tag. [required]
  • --domain TEXT: Create or update a room route for the deployed service. Requires exactly one published service port.
  • --room-mount TEXT: Mount room storage as <source>:<mount>[:ro|rw]
  • --project-mount TEXT: Mount project storage as <source>:<mount>[:ro|rw]
  • --empty-dir-mount TEXT: Mount empty dir at <mount>[:ro|rw]
  • --image-mount TEXT: Mount image as <image>=<mount>[:ro|rw]
  • -e, --env TEXT: Set environment variable as KEY=VALUE
  • --env-token TEXT: Inject MESHAGENT_TOKEN using userDefault, agentDefault, full, or a JSON ApiScope object.
  • --private / --public: Whether published service ports should stay private or be public when they are created or updated.
  • --help: Show this message and exit.

meshagent image pack

Pack a local directory into an OCI image archive. Usage:
$ meshagent image pack [OPTIONS] PATH
Arguments:
  • PATH: Local directory to pack [required]
Options:
  • --project-id TEXT: A MeshAgent project id. If empty, the activated project will be used.
  • --room TEXT: Room name
  • --tag TEXT: Image reference to embed in the packed archive. Required with —room, and must start with room.meshagent.com/ there.
  • -o, --output TEXT: Local path to write the OCI archive tar. Required unless —room is set.
  • --base TEXT: Optional base image reference. Defaults to scratch semantics.
  • --arch TEXT: Architecture to use when resolving —base [default: amd64]
  • --room-path TEXT: Room storage path to upload the archive to when —room is set. Defaults to the repository path from —tag.
  • --help: Show this message and exit.