- CLI Reference
- Commands
- ironflow run
ironflow run
List and inspect workflow runs, and control them: cancel, pause, inject step output, and resume.
ironflow run <subcommand> [flags]ironflow run list
Section titled “ironflow run list”List workflow runs with optional filtering.
ironflow run list [flags]Flags:
| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
--server | -s | string | Server URL override | |
--function | string | Filter by function ID | ||
--status | string | Filter by status (waiting_for_capacity, waiting, running, completed, failed, cancelled, paused) | ||
--limit | int | 50 | Maximum number of runs to return | |
--json | bool | false | Output as JSON |
Output:
ID FUNCTION STATUS STARTEDrun-1 stripe-handler completed 2025-01-15 12:00:05run-2 order-process failed 2025-01-15 11:59:30ironflow run get
Section titled “ironflow run get”Get detailed information about a specific workflow run.
ironflow run get <run-id> [flags]Arguments:
| Argument | Required | Description |
|---|---|---|
run-id | Yes | The run ID to look up |
Flags:
| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
--server | -s | string | Server URL override | |
--json | bool | false | Output as JSON |
Output:
ID: run-abc123Function: stripe-handlerStatus: completedMode: pushEvent: evt_01HN8K3X5YStarted: 2025-01-15T12:00:05ZEnded: 2025-01-15T12:00:06ZDuration: 1.2sironflow run cancel
Section titled “ironflow run cancel”Cancel a queued, running, or paused workflow run.
ironflow run cancel <run-id> [flags]Arguments:
| Argument | Required | Description |
|---|---|---|
run-id | Yes | The run ID to cancel |
Flags:
| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
--reason | string | Cancellation reason | ||
--server | -s | string | Server URL override |
Output:
Canceled run run-abc123 (status: cancelled)Examples:
ironflow run listironflow run list --function stripe-handler --status failedironflow run list --limit 10 --jsonironflow run get run_abc123ironflow run get run_abc123 --jsonironflow run cancel run_abc123ironflow run cancel run_abc123 --reason "no longer needed"ironflow run pause
Section titled “ironflow run pause”Pause a running workflow at the next step boundary for inspection and injection.
ironflow run pause <run-id> [flags]If the run is currently executing, sets a pause flag that is consumed at the next step boundary. If the run is already paused (sleeping or waiting for an event), it immediately transitions to an injection pause.
Arguments:
| Argument | Required | Description |
|---|---|---|
run-id | Yes | The run ID to pause |
Flags:
| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
--server | -s | string | Server URL override |
Output:
Run run-abc123: pausedExamples:
# Pause a running workflowironflow run pause run_abc123
# Pause against a different serverironflow run pause run_abc123 --server http://prod:9123ironflow run paused-state
Section titled “ironflow run paused-state”View completed steps and their outputs for a run paused for injection.
ironflow run paused-state <run-id> [flags]Only works on runs with pause_reason = "injection". Shows each completed step’s ID, name, whether it was injected, and its output. Also displays the pause reason and next step hint if available.
Arguments:
| Argument | Required | Description |
|---|---|---|
run-id | Yes | The paused run ID to inspect |
Flags:
| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
--json | bool | false | Output as JSON | |
--server | -s | string | Server URL override |
Output:
Pause reason: injectionNext step: send-notification
ID NAME INJECTED OUTPUTstep_001 validate-input {"valid":true}step_002 process-order {"order_id":"123","total":99.99}Examples:
# View paused stateironflow run paused-state run_abc123
# JSON output for scriptingironflow run paused-state run_abc123 --jsonironflow run inject
Section titled “ironflow run inject”Modify the output of a completed step while a run is paused for injection.
ironflow run inject <run-id> <step-id> [flags]Replaces the step’s output with new data. The original output is preserved in original_output for audit purposes. An audit event (step.injected) is emitted if the function has recording enabled.
Arguments:
| Argument | Required | Description |
|---|---|---|
run-id | Yes | The paused run ID |
step-id | Yes | The completed step ID to modify |
Flags:
| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
--output | string | New JSON output for the step (required) | ||
--reason | string | Reason for the injection (optional) | ||
--server | -s | string | Server URL override |
Output:
Injected step step_002Previous output: {"order_id":"123","total":99.99}Examples:
# Inject modified outputironflow run inject run_abc123 step_002 --output '{"order_id":"123","total":89.99}'
# Inject with a reason for the audit trailironflow run inject run_abc123 step_002 \ --output '{"corrected": true}' \ --reason "Fix calculation error"ironflow run resume
Section titled “ironflow run resume”Resume a paused or failed run. When resuming an injection-paused run, clears the pause state and re-dispatches from where it left off.
ironflow run resume <run-id> [flags]Arguments:
| Argument | Required | Description |
|---|---|---|
run-id | Yes | The run ID to resume |
Flags:
| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
--from-step | string | Resume from a specific step ID | ||
--server | -s | string | Server URL override |
Output:
Resumed run run-abc123 (status: running)Examples:
# Resume a paused runironflow run resume run_abc123
# Resume from a specific stepironflow run resume run_abc123 --from-step step_002
# Typical scoped injection workflowironflow run pause run_abc123ironflow run paused-state run_abc123ironflow run inject run_abc123 step_002 --output '{"fixed": true}' --reason "correct value"ironflow run resume run_abc123