Deployments.ai Docs
Command reference

deployments agent

Agent definitions and lifecycle shortcuts

CommandSummary
deployments agent createCreate an agent definition
deployments agent listList agent definitions
deployments agent showShow an agent definition
deployments agent updateUpdate an agent definition
deployments agent releaseCreate an immutable agent release
deployments agent deployDeploy an agent release
deployments agent archiveArchive an agent definition

deployments agent create

Create an agent definition.

deployments agent create --manifest <json>
  • Calls POST /v1/agent-definitions (SDK createAgentDefinition).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
--manifeststring (json)yesAgent manifest JSON

Also accepts the global flags.

deployments agent list

List agent definitions.

deployments agent list
  • Calls GET /v1/agent-definitions (SDK listAgentDefinitions).
  • Needs an environment: --env or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size

Also accepts the global flags.

deployments agent show

Show an agent definition.

deployments agent show <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments agent update

Update an agent definition.

deployments agent update <id> --manifest <json> --expected-version <number>
  • Calls PATCH /v1/agent-definitions/{id} (SDK updateAgentDefinition).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--manifeststring (json)yesAgent manifest JSON
--expected-versionstring (number)yesExpected resource version

Also accepts the global flags.

deployments agent release

Create an immutable agent release.

deployments agent release <id> --expected-version <number>
  • Calls POST /v1/agent-definitions/{id}/releases (SDK publishAgentRelease).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--expected-versionstring (number)yesExpected agent definition version

Also accepts the global flags.

deployments agent deploy

Deploy an agent release.

deployments agent deploy --release <release>
  • Calls POST /v1/agent-deployments (SDK createAgentDeployment).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
--releasestringyesAgent release ID
--desired-statestringrunning or paused
--runtime-configstring (json)Deployment runtime configuration

Also accepts the global flags.

deployments agent archive

Archive an agent definition.

deployments agent archive <id> --expected-version <number>
  • Calls DELETE /v1/agent-definitions/{id} (SDK archiveAgentDefinition).
  • Needs an environment: --env or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--expected-versionstring (number)yesExpected resource version

Also accepts the global flags.

On this page