Command reference
deployments release
Immutable agent releases
| Command | Summary |
|---|---|
deployments release list | List releases for an agent definition |
deployments release show | Show an agent release |
deployments release archive | Archive an agent release |
deployments release promote | Promote an agent release into another environment |
deployments release list
List releases for an agent definition.
deployments release list <id>- Calls
GET /v1/agent-definitions/{id}/releases(SDKlistAgentReleases). - Needs an environment:
--envor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size | ||
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments release show
Show an agent release.
deployments release show <id>- Calls
GET /v1/agent-releases/{id}(SDKgetAgentRelease). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments release archive
Archive an agent release.
deployments release archive <id> --expected-version <number>- Calls
DELETE /v1/agent-releases/{id}(SDKarchiveAgentRelease). - Needs an environment:
--envor the saved context. - Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID | |
--expected-version | string (number) | yes | Expected resource version |
Also accepts the global flags.
deployments release promote
Promote an agent release into another environment.
deployments release promote <id> --target-environment <target-environment>- Calls
POST /v1/agent-releases/{id}/promote(SDKpromoteAgentRelease). - Needs an environment:
--envor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID | |
--target-environment | string | yes | Target environment ID |
Also accepts the global flags.