Deployments.ai Docs
Command reference

deployments app

Internal apps that agents build and members sign in to

CommandSummary
deployments app listList apps, or find one by its slug
deployments app showShow an app, its URL, and its lifecycle
deployments app updateRename an app, set member access, or hand it to another agent definition
deployments app set-publicationChange an app's audience and serving settings (needs apps:publish)
deployments app archiveArchive an app so it stops serving members and agents
deployments app eraseErase an app and its data

deployments app list

List apps, or find one by its slug.

deployments app list
  • Calls GET /v1/apps (SDK listApps).
  • 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
--slugstringOnly the app with this exact slug

Also accepts the global flags.

deployments app show

Show an app, its URL, and its lifecycle.

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

Also accepts the global flags.

deployments app update

Rename an app, set member access, or hand it to another agent definition.

deployments app update <id>
  • Calls PATCH /v1/apps/{appId} (SDK updateApp).
  • 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
--namestringApp name
--accessstring (json)Access for every organization member, such as {"organizationMembers":"viewer"}
--agent-definition-idstringAgent definition whose runs can reach the app

Also accepts the global flags.

deployments app set-publication

Change an app's audience and serving settings (needs apps:publish).

deployments app set-publication <id>
  • Calls PATCH /v1/apps/{appId}/publication (SDK setAppPublication).
  • 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
--audiencestringmembers or public
--servingstringsingle-page or static-site

Also accepts the global flags.

deployments app archive

Archive an app so it stops serving members and agents.

deployments app archive <id>
  • Calls POST /v1/apps/{appId}/archive (SDK archiveApp).
  • 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

Also accepts the global flags.

deployments app erase

Erase an app and its data.

deployments app erase <id>
  • Calls DELETE /v1/apps/{appId} (SDK eraseApp).
  • 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

Also accepts the global flags.

On this page