Deployments.ai Docs
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.

FlagTypeRequiredDefaultDescription
--profilestring (name)Configuration profile
--api-urlstring (url)Platform API base URL
--api-keystring (key)Bearer token
--orgstring (id)Organization ID
--projectstring (id)Project ID
--envstring (id)Environment ID
--workspacestring (id)Workspace ID
--mockbooleanUse the local mock transport
--livebooleanUse the configured live API transport
--jsonbooleanEmit JSON output
--quietbooleanSuppress successful output
--color, --no-colorbooleantrueUse ANSI color
--revealbooleanReveal one-time secrets in output
--yes, -ybooleanSkip destructive-action confirmation
--idempotency-keystring (key)Explicit idempotency key

Commands

CommandSummary
deployments agentAgent definitions and lifecycle shortcuts
deployments api-keyEnvironment-scoped API credentials
deployments appInternal apps that agents build and members sign in to
deployments app-domainCustom hostnames that serve an app once their DNS records are published
deployments app-grantMember roles on an app beyond its organization-wide access
deployments app-releasePublished builds of an app's UI
deployments approvalHuman approval decisions
deployments artifactRun and message artifacts
deployments auditTenant audit history
deployments authAuthentication profiles
deployments brainGoverned company and member-private knowledge Brains
deployments brain-documentImmutable Brain document revisions
deployments brain-entityCanonical Brain entities and cited relationships
deployments brain-erasureGeneration-fenced Brain erasure operations
deployments brain-feedbackBrain answer and retrieval usefulness feedback
deployments brain-grantHuman, service, and agent Brain grants
deployments brain-mountDeployment Brain mounts
deployments brain-reviewBrain curator review items
deployments brain-sourceBrain knowledge sources
deployments brain-uploadControlled Brain content uploads
deployments budgetOrganization, project, environment, and workspace spend budgets
deployments callback-evidenceImmutable callback dispatch authorization evidence
deployments capabilityVerified connection capabilities
deployments catalogPrint the complete public CLI command catalog
deployments channel-bindingInbound and outbound channel bindings
deployments channel-deliveryOutbound channel delivery inspection
deployments chatSend a chat message to an agent deployment
deployments connectionProvider connections and verification
deployments contextPersistent organization, project, environment, and workspace context
deployments costEstimated and provider-reported costs
deployments credentialStatic provider credentials
deployments credential-referenceMetadata-only inventory of stored secrets and their owners
deployments deploymentEnvironment agent deployments
deployments devChat with a local agent manifest through a temporary preview
deployments directorySCIM directory sync, which provisions organization members from an identity provider
deployments draftAgent email drafts
deployments egress-allowlistOrigins tools may reach without approval inside a data boundary
deployments emailPlatform tenant-scoped email delivery
deployments email-domainSend-only domain ownership and DNS verification
deployments email-placementAgent email regional placements
deployments email-policyAgent email sending policy
deployments email-suppressionAgent email suppressions
deployments email-tenantPlatform sending tenants
deployments email-usageAgent email usage
deployments end-userErase every conversation one of your end users owns
deployments envProject environments
deployments evalEvaluate agents with scores, regression datasets, runs, and release comparisons
deployments extensionCustom MCP and callback tools
deployments governanceRetention, tenant data, and immutable audit exports
deployments grantAgent connection grants
deployments healthCheck public API health
deployments heartbeatAgent liveness and heartbeat events
deployments hosted-code-artifactImmutable hosted code tool artifacts
deployments identity-providerThe organization's OIDC or SAML identity provider for single sign-on
deployments inboxAgent email inboxes
deployments inbox-attachmentAgent email attachments
deployments inbox-bindingAgent email inbox bindings
deployments inbox-domainCustom sending and receiving domains
deployments inbox-messageAgent email messages
deployments inbox-threadAgent email threads
deployments invitationOrganization invitations
deployments login-domainEmail domains the organization proves it controls for single sign-on
deployments managed-skillInspectable managed skill content
deployments managed-skill-installationEnvironment managed skill installations
deployments managed-skill-releaseImmutable managed skill releases
deployments managed-skill-sourceManaged skill catalog sources
deployments mcp-connectionMCP runtime connections
deployments mcp-serverRemote MCP servers
deployments memberOrganization members and roles
deployments memoryMemory import, export, review, and retrieval
deployments memory-policyMemory recall and sensitivity policy
deployments memory-retrievalMemory retrieval feedback
deployments memory-reviewMemory governance review queue
deployments memory-spaceGoverned memory spaces
deployments memory-space-grantAgent access to governed memory spaces
deployments messagePersisted thread messages
deployments modelHosted model catalog and environment admission
deployments model-credentialThe organization's own model provider keys
deployments model-policyEnvironment model admission policy
deployments monitorMonitors that email members and send webhook events when something needs attention
deployments oauth-appSubscriber-owned OAuth applications
deployments observabilityHot observability metrics, tools, and exports
deployments openapiFetch the public OpenAPI document
deployments orgOrganizations and tenancy
deployments previewUnpublished agent manifest previews
deployments projectProjects
deployments providerProvider catalog
deployments releaseImmutable agent releases
deployments runAgent execution and timelines
deployments scheduleScheduled agent runs
deployments service-accountMachine identities
deployments spendSpend and cost summaries
deployments systemInstall operator status for platform administrators
deployments threadConversation threads
deployments toolPlatform tool catalog and hosted code tools
deployments tool-callTool calls and asynchronous results
deployments tool-policyTool permissions and approval policy
deployments traceHot observability traces and execution trees
deployments usageMetered usage
deployments verificationConnection verification results
deployments webhookSigned semantic webhooks
deployments webhook-deliveryWebhook delivery attempts
deployments whoamiShow the authenticated identity
deployments workflowVersioned deterministic workflow definitions
deployments workflow-approvalWorkflow approval decisions
deployments workflow-executionDurable workflow executions
deployments workflow-releaseImmutable workflow releases
deployments workspaceEnvironment workspaces

On this page