Command reference
deployments workflow
Versioned deterministic workflow definitions
| Command | Summary |
|---|---|
deployments workflow list | List workflow definitions |
deployments workflow create | Create a workflow definition |
deployments workflow show | Show a workflow definition |
deployments workflow update | Update a workflow definition |
deployments workflow archive | Archive a workflow definition |
deployments workflow release | Publish an immutable workflow release |
deployments workflow list
List workflow definitions.
deployments workflow list- Calls
GET /v1/workflow-definitions(SDKlistWorkflowDefinitions). - 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 |
Also accepts the global flags.
deployments workflow create
Create a workflow definition.
deployments workflow create --definition <json>- Calls
POST /v1/workflow-definitions(SDKcreateWorkflowDefinition). - 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 |
|---|---|---|---|---|
--definition | string (json) | yes | Workflow definition document |
Also accepts the global flags.
deployments workflow show
Show a workflow definition.
deployments workflow show <id>- Calls
GET /v1/workflow-definitions/{id}(SDKgetWorkflowDefinition). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments workflow update
Update a workflow definition.
deployments workflow update <id> --definition <json> --expected-version <number>- Calls
PATCH /v1/workflow-definitions/{id}(SDKupdateWorkflowDefinition). - 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 | |
--definition | string (json) | yes | Workflow definition document | |
--expected-version | string (number) | yes | Expected resource version |
Also accepts the global flags.
deployments workflow archive
Archive a workflow definition.
deployments workflow archive <id> --expected-version <number>- Calls
DELETE /v1/workflow-definitions/{id}(SDKarchiveWorkflowDefinition). - 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 workflow release
Publish an immutable workflow release.
deployments workflow release <id> --expected-definition-version <number>- Calls
POST /v1/workflow-definitions/{id}/releases(SDKpublishWorkflowRelease). - 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 | |
--expected-definition-version | string (number) | yes | Expected workflow definition version |
Also accepts the global flags.