Deployments.ai Docs
Command reference

deployments workspace

Environment workspaces

CommandSummary
deployments workspace createCreate a workspace
deployments workspace listList workspaces
deployments workspace showShow a workspace
deployments workspace updateUpdate a workspace
deployments workspace archiveArchive a workspace
deployments workspace spendShow a workspace's spend for a month, split into operator-funded and organization-funded

deployments workspace create

Create a workspace.

deployments workspace create --name <name>
  • Calls POST /v1/workspaces (SDK createWorkspace).
  • 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
--namestringyesResource name
--descriptionstringResource description
--slugstringURL-safe workspace slug

Also accepts the global flags.

deployments workspace list

List workspaces.

deployments workspace list
  • Calls GET /v1/workspaces (SDK listWorkspaces).
  • 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 workspace show

Show a workspace.

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

Also accepts the global flags.

deployments workspace update

Update a workspace.

deployments workspace update <id>
  • Calls PATCH /v1/workspaces/{id} (SDK updateWorkspace).
  • 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
--namestringNew workspace name
--descriptionstringNew workspace description
--slugstringNew workspace slug

Also accepts the global flags.

deployments workspace archive

Archive a workspace.

deployments workspace archive <id>
  • Calls DELETE /v1/workspaces/{id} (SDK archiveWorkspace).
  • 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
--reasonstringReason for this operation

Also accepts the global flags.

deployments workspace spend

Show a workspace's spend for a month, split into operator-funded and organization-funded.

deployments workspace spend <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--monthstringUTC month as YYYY-MM; defaults to the current month

Also accepts the global flags.

On this page