Command reference
deployments workflow-execution
Durable workflow executions
| Command | Summary |
|---|---|
deployments workflow-execution list | List workflow executions |
deployments workflow-execution start | Start an immutable workflow release |
deployments workflow-execution show | Show a workflow execution |
deployments workflow-execution steps | List workflow step attempts |
deployments workflow-execution cancel | Request workflow execution cancellation |
deployments workflow-execution list
List workflow executions.
deployments workflow-execution list- Calls
GET /v1/workflow-executions(SDKlistWorkflowExecutions). - 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 | ||
--status | string | Workflow execution status |
Also accepts the global flags.
deployments workflow-execution start
Start an immutable workflow release.
deployments workflow-execution start --release <release>- Calls
POST /v1/workflow-releases/{workflowReleaseId}/executions(SDKstartWorkflowExecution). - 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 |
|---|---|---|---|---|
--release | string | yes | Workflow release ID | |
--input | string (json) | Workflow input JSON | ||
--workspace-id | string | Workspace ID |
Also accepts the global flags.
deployments workflow-execution show
Show a workflow execution.
deployments workflow-execution show <id>- Calls
GET /v1/workflow-executions/{workflowExecutionId}(SDKgetWorkflowExecution). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments workflow-execution steps
List workflow step attempts.
deployments workflow-execution steps <id>- Calls
GET /v1/workflow-executions/{workflowExecutionId}/steps(SDKlistWorkflowStepAttempts). - 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 workflow-execution cancel
Request workflow execution cancellation.
deployments workflow-execution cancel <id> --expected-version <number>- Calls
POST /v1/workflow-executions/{workflowExecutionId}/cancel(SDKcancelWorkflowExecution). - Needs an environment:
--envor the saved context. - Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID | |
--expected-version | string (number) | yes | Expected workflow execution version |
Also accepts the global flags.