Deployments.ai Docs
Command reference

deployments project

Projects

CommandSummary
deployments project createCreate a project
deployments project listList projects
deployments project showShow a project
deployments project updateUpdate a project
deployments project archiveArchive a project

deployments project create

Create a project.

deployments project create --name <name>
  • Calls POST /v1/projects (SDK createProject).
  • Needs an organization: --org or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
--namestringyesResource name
--slugstringURL-safe project slug

Also accepts the global flags.

deployments project list

List projects.

deployments project list
  • Calls GET /v1/projects (SDK listProjects).
  • Needs an organization: --org 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 project show

Show a project.

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

Also accepts the global flags.

deployments project update

Update a project.

deployments project update <id>
  • Calls PATCH /v1/projects/{id} (SDK updateProject).
  • Needs a project: --project 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 project name
--slugstringNew project slug

Also accepts the global flags.

deployments project archive

Archive a project.

deployments project archive <id>
  • Calls DELETE /v1/projects/{id} (SDK archiveProject).
  • Needs a project: --project 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.

On this page