sim workflows is also spelled sim workflow.
Every command below also accepts the global options.
Cancel a running workflow run
sim workflows runs cancel <runId> [options]Arguments
| Argument | Required | Description |
|---|---|---|
runId | Yes | Unique workflow run identifier. |
Options
| Option | Required | Description |
|---|---|---|
--workflow <workflowId> | Yes | Workflow ID. |
Show run status
sim workflows runs get <runId> [options]Show run status (requested outputs are included in JSON or YAML output)
Arguments
| Argument | Required | Description |
|---|---|---|
runId | Yes | Unique workflow run identifier. |
Options
| Option | Required | Description |
|---|---|---|
--workflow <workflowId> | Yes | Workflow ID. |
--include-output | No | Include the final output in JSON or YAML output. |
--select-output <value...> | No | Include blockName.field values in JSON or YAML output (e.g. agent_1.content) (space-separated, or @path / @- with one value per line). |
List runs for a workflow
sim workflows runs list [options]Options
| Option | Required | Description |
|---|---|---|
--workflow <workflowId> | Yes | Workflow ID. |
--status <value> | No | Filter by run status. Accepted values: pending, running, completed, failed, cancelled, paused. |
--trigger <value> | No | Filter by trigger type. |
--start-date <value> | No | Only include runs started at or after this UTC ISO 8601 timestamp, e.g. 2026-08-06T00:00:00Z. A date without a time, or a timestamp carrying a UTC offset instead of Z, is rejected, as is year 0000, which names no storable instant. |
--end-date <value> | No | Only include runs started at or before this UTC ISO 8601 timestamp, e.g. 2026-08-06T00:00:00Z. A date without a time, or a timestamp carrying a UTC offset instead of Z, is rejected, as is year 0000, which names no storable instant. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--order <value> | No | Sort direction by run start time. This list is sortable only by run start time, so it takes order in place of sortBy/sortOrder, which it rejects. Accepted values: asc, desc. |
Resume a paused run
sim workflows runs resume <runId> [options]Resume a paused run (output is included in JSON or YAML output)
Arguments
| Argument | Required | Description |
|---|---|---|
runId | Yes | Unique workflow run identifier. |
Options
| Option | Required | Description |
|---|---|---|
--workflow <workflowId> | Yes | Workflow ID. |
--context <value> | Yes | Pause context ID returned by run status. |
--input <json|@file> | No | Resume input as JSON (JSON, or @path / @- to read a file or stdin). |
Create workflow
sim workflows create [options]Options
| Option | Required | Description |
|---|---|---|
--name <value> | Yes | Workflow name. |
--description <value> | No | Optional workflow description. |
--folder <value> | No | Folder path; the leading / is optional. |
Create a workflow folder at a path
sim workflows folders create <path>Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path; the leading / is optional |
Delete workflow folder
sim workflows folders delete <path> [options]Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path; the leading / is optional |
Options
| Option | Required | Description |
|---|---|---|
--recursive | No | Delete the folder and its descendants. |
-y, --yes | No | Skip the confirmation. |
List workflow folders
sim workflows folders list [options]Also available as sim workflows folders ls.
Options
| Option | Required | Description |
|---|---|---|
--parent <value> | No | Direct parent folder path. |
--search <value> | No | Case-insensitive substring match against the folder name. |
--sort-by <value> | No | Field used to sort the result. Sorting by name is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: name, createdAt, updatedAt. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
Rename or move a workflow folder
sim workflows folders move <path> <destination>Also available as sim workflows folders mv.
Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path; the leading / is optional |
destination | Yes | Folder path; the leading / is optional |
Delete workflow
sim workflows delete <id> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
-y, --yes | No | Skip the confirmation. |
Deploy workflow
sim workflows deploy <id> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
--name <value> | No | Optional label for the deployment version. |
--description <value> | No | Optional release note for the deployment version. |
Run a deployed workflow
sim workflows run <id> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
--input <json|@file> | No | Trigger input as JSON (JSON, or @path / @- to read a file or stdin). |
--async | No | Queue the run and return immediately. |
--execution-timeout-seconds <value> | No | Requested server-side timeout for an asynchronous run, in seconds. An upper bound, not the effective timeout: the run uses the smaller of this value and the plan's execution timeout, so requesting more than the plan allows silently yields the plan timeout. Rejected with 400 unless async is true. |
--select-output <value...> | No | Return blockName.field values (e.g. agent_1.content); missing fields are omitted (space-separated, or @path / @- with one value per line). |
--include-file-base64 | No | Inline eligible output files as base64 content. Rejected when async is true. |
--no-include-file-base64 | No | Send --include-file-base64 as false. |
--base64-max-bytes <value> | No | Maximum total bytes of file content to inline as base64. Rejected when async is true. |
Print a workflow as a portable JSON document
sim workflows export <id>Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique workflow identifier. |
Get workflow
sim workflows get <id>Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique workflow identifier. |
Get workflow deployment
sim workflows deployment list <id>Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique workflow identifier. |
Get workflow version
sim workflows versions get <id> <version>Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique workflow identifier. |
version | Yes | Numeric deployment version. |
List workflow versions
sim workflows versions list <id> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
Import workflow
sim workflows import [options]Options
| Option | Required | Description |
|---|---|---|
--workflow <json|@file> | Yes | Workflow export object, bare workflow state, or JSON string containing either form. (JSON, or @path / @- to read a file or stdin). |
--folder <value> | No | Folder path; the leading / is optional. |
--name <value> | No | Override for the imported workflow name. |
--description <value> | No | Override for the imported workflow description. |
List workflows
sim workflows list [options]Options
| Option | Required | Description |
|---|---|---|
--folder <value> | No | Folder path; the leading / is optional. |
--deployed-only | No | Return only workflows with an active deployment when true. |
--no-deployed-only | No | Send --deployed-only as false. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 100. |
--search <value> | No | Case-insensitive substring match against the resource name. |
--sort-by <value> | No | Field used to sort the result. Sorting by name is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: position, name, createdAt, updatedAt, runCount. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
Rollback workflow
sim workflows rollback <id> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
--version <value> | No | Deployment version to reactivate. Omit to select the previous active version. |
Take a workflow out of deployment
sim workflows undeploy <id>Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique workflow identifier. |
Update workflow
sim workflows update <id> [options]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique workflow identifier. |
Options
| Option | Required | Description |
|---|---|---|
--name <value> | No | Replacement workflow name. |
--description <value> | No | Replacement workflow description; null clears it. |
--folder <value> | No | Folder path; the leading / is optional. |
Move a workflow to a folder
sim workflows mv <id> <folder>Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Unique workflow identifier. |
folder | Yes | Folder path; the leading / is optional |
List workflow resources and child folders together
sim workflows ls [path] [options]Arguments
| Argument | Required | Description |
|---|---|---|
path | No | Folder path to list; defaults to the root folder |
Options
| Option | Required | Description |
|---|---|---|
--search <text> | No | Filter folders and resources by name. |
--limit <n> | No | Maximum combined items to return (0 for everything). Defaults to 100. |
Create a workflow directory at a path
sim workflows mkdir <path>Arguments
| Argument | Required | Description |
|---|---|---|
path | Yes | Folder path to create; the leading / is optional |