Command reference
Command reference
Every `deployments` command, generated from the CLI source.
Generated from the deployments command tree (CLI 0.1.0-alpha.1). Each page documents one top-level command and all of its subcommands.
Global flags
Every resource command accepts these flags. A command page lists them again only when the command changes one.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--profile | string (name) | Configuration profile | ||
--api-url | string (url) | Platform API base URL | ||
--api-key | string (key) | Bearer token | ||
--org | string (id) | Organization ID | ||
--project | string (id) | Project ID | ||
--env | string (id) | Environment ID | ||
--workspace | string (id) | Workspace ID | ||
--mock | boolean | Use the local mock transport | ||
--live | boolean | Use the configured live API transport | ||
--json | boolean | Emit JSON output | ||
--quiet | boolean | Suppress successful output | ||
--color, --no-color | boolean | true | Use ANSI color | |
--reveal | boolean | Reveal one-time secrets in output | ||
--yes, -y | boolean | Skip destructive-action confirmation | ||
--idempotency-key | string (key) | Explicit idempotency key |
Commands
| Command | Summary |
|---|---|
deployments agent | Agent definitions and lifecycle shortcuts |
deployments api-key | Environment-scoped API credentials |
deployments app | Internal apps that agents build and members sign in to |
deployments app-domain | Custom hostnames that serve an app once their DNS records are published |
deployments app-grant | Member roles on an app beyond its organization-wide access |
deployments app-release | Published builds of an app's UI |
deployments approval | Human approval decisions |
deployments artifact | Run and message artifacts |
deployments audit | Tenant audit history |
deployments auth | Authentication profiles |
deployments brain | Governed company and member-private knowledge Brains |
deployments brain-document | Immutable Brain document revisions |
deployments brain-entity | Canonical Brain entities and cited relationships |
deployments brain-erasure | Generation-fenced Brain erasure operations |
deployments brain-feedback | Brain answer and retrieval usefulness feedback |
deployments brain-grant | Human, service, and agent Brain grants |
deployments brain-mount | Deployment Brain mounts |
deployments brain-review | Brain curator review items |
deployments brain-source | Brain knowledge sources |
deployments brain-upload | Controlled Brain content uploads |
deployments budget | Organization, project, environment, and workspace spend budgets |
deployments callback-evidence | Immutable callback dispatch authorization evidence |
deployments capability | Verified connection capabilities |
deployments catalog | Print the complete public CLI command catalog |
deployments channel-binding | Inbound and outbound channel bindings |
deployments channel-delivery | Outbound channel delivery inspection |
deployments chat | Send a chat message to an agent deployment |
deployments connection | Provider connections and verification |
deployments context | Persistent organization, project, environment, and workspace context |
deployments cost | Estimated and provider-reported costs |
deployments credential | Static provider credentials |
deployments credential-reference | Metadata-only inventory of stored secrets and their owners |
deployments deployment | Environment agent deployments |
deployments dev | Chat with a local agent manifest through a temporary preview |
deployments directory | SCIM directory sync, which provisions organization members from an identity provider |
deployments draft | Agent email drafts |
deployments egress-allowlist | Origins tools may reach without approval inside a data boundary |
deployments email | Platform tenant-scoped email delivery |
deployments email-domain | Send-only domain ownership and DNS verification |
deployments email-placement | Agent email regional placements |
deployments email-policy | Agent email sending policy |
deployments email-suppression | Agent email suppressions |
deployments email-tenant | Platform sending tenants |
deployments email-usage | Agent email usage |
deployments end-user | Erase every conversation one of your end users owns |
deployments env | Project environments |
deployments eval | Evaluate agents with scores, regression datasets, runs, and release comparisons |
deployments extension | Custom MCP and callback tools |
deployments governance | Retention, tenant data, and immutable audit exports |
deployments grant | Agent connection grants |
deployments health | Check public API health |
deployments heartbeat | Agent liveness and heartbeat events |
deployments hosted-code-artifact | Immutable hosted code tool artifacts |
deployments identity-provider | The organization's OIDC or SAML identity provider for single sign-on |
deployments inbox | Agent email inboxes |
deployments inbox-attachment | Agent email attachments |
deployments inbox-binding | Agent email inbox bindings |
deployments inbox-domain | Custom sending and receiving domains |
deployments inbox-message | Agent email messages |
deployments inbox-thread | Agent email threads |
deployments invitation | Organization invitations |
deployments login-domain | Email domains the organization proves it controls for single sign-on |
deployments managed-skill | Inspectable managed skill content |
deployments managed-skill-installation | Environment managed skill installations |
deployments managed-skill-release | Immutable managed skill releases |
deployments managed-skill-source | Managed skill catalog sources |
deployments mcp-connection | MCP runtime connections |
deployments mcp-server | Remote MCP servers |
deployments member | Organization members and roles |
deployments memory | Memory import, export, review, and retrieval |
deployments memory-policy | Memory recall and sensitivity policy |
deployments memory-retrieval | Memory retrieval feedback |
deployments memory-review | Memory governance review queue |
deployments memory-space | Governed memory spaces |
deployments memory-space-grant | Agent access to governed memory spaces |
deployments message | Persisted thread messages |
deployments model | Hosted model catalog and environment admission |
deployments model-credential | The organization's own model provider keys |
deployments model-policy | Environment model admission policy |
deployments monitor | Monitors that email members and send webhook events when something needs attention |
deployments oauth-app | Subscriber-owned OAuth applications |
deployments observability | Hot observability metrics, tools, and exports |
deployments openapi | Fetch the public OpenAPI document |
deployments org | Organizations and tenancy |
deployments preview | Unpublished agent manifest previews |
deployments project | Projects |
deployments provider | Provider catalog |
deployments release | Immutable agent releases |
deployments run | Agent execution and timelines |
deployments schedule | Scheduled agent runs |
deployments service-account | Machine identities |
deployments spend | Spend and cost summaries |
deployments system | Install operator status for platform administrators |
deployments thread | Conversation threads |
deployments tool | Platform tool catalog and hosted code tools |
deployments tool-call | Tool calls and asynchronous results |
deployments tool-policy | Tool permissions and approval policy |
deployments trace | Hot observability traces and execution trees |
deployments usage | Metered usage |
deployments verification | Connection verification results |
deployments webhook | Signed semantic webhooks |
deployments webhook-delivery | Webhook delivery attempts |
deployments whoami | Show the authenticated identity |
deployments workflow | Versioned deterministic workflow definitions |
deployments workflow-approval | Workflow approval decisions |
deployments workflow-execution | Durable workflow executions |
deployments workflow-release | Immutable workflow releases |
deployments workspace | Environment workspaces |