Skip to content

ironflow run

List and inspect workflow runs, and control them: cancel, pause, inject step output, and resume.

Terminal window
ironflow run <subcommand> [flags]

List workflow runs with optional filtering.

Terminal window
ironflow run list [flags]

Flags:

FlagShortTypeDefaultDescription
--server-sstringServer URL override
--functionstringFilter by function ID
--statusstringFilter by status (waiting_for_capacity, waiting, running, completed, failed, cancelled, paused)
--limitint50Maximum number of runs to return
--jsonboolfalseOutput as JSON

Output:

ID FUNCTION STATUS STARTED
run-1 stripe-handler completed 2025-01-15 12:00:05
run-2 order-process failed 2025-01-15 11:59:30

Get detailed information about a specific workflow run.

Terminal window
ironflow run get <run-id> [flags]

Arguments:

ArgumentRequiredDescription
run-idYesThe run ID to look up

Flags:

FlagShortTypeDefaultDescription
--server-sstringServer URL override
--jsonboolfalseOutput as JSON

Output:

ID: run-abc123
Function: stripe-handler
Status: completed
Mode: push
Event: evt_01HN8K3X5Y
Started: 2025-01-15T12:00:05Z
Ended: 2025-01-15T12:00:06Z
Duration: 1.2s

Cancel a queued, running, or paused workflow run.

Terminal window
ironflow run cancel <run-id> [flags]

Arguments:

ArgumentRequiredDescription
run-idYesThe run ID to cancel

Flags:

FlagShortTypeDefaultDescription
--reasonstringCancellation reason
--server-sstringServer URL override

Output:

Canceled run run-abc123 (status: cancelled)

Examples:

Terminal window
ironflow run list
ironflow run list --function stripe-handler --status failed
ironflow run list --limit 10 --json
ironflow run get run_abc123
ironflow run get run_abc123 --json
ironflow run cancel run_abc123
ironflow run cancel run_abc123 --reason "no longer needed"

Pause a running workflow at the next step boundary for inspection and injection.

Terminal window
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:

ArgumentRequiredDescription
run-idYesThe run ID to pause

Flags:

FlagShortTypeDefaultDescription
--server-sstringServer URL override

Output:

Run run-abc123: paused

Examples:

Terminal window
# Pause a running workflow
ironflow run pause run_abc123
# Pause against a different server
ironflow run pause run_abc123 --server http://prod:9123

View completed steps and their outputs for a run paused for injection.

Terminal window
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:

ArgumentRequiredDescription
run-idYesThe paused run ID to inspect

Flags:

FlagShortTypeDefaultDescription
--jsonboolfalseOutput as JSON
--server-sstringServer URL override

Output:

Pause reason: injection
Next step: send-notification
ID NAME INJECTED OUTPUT
step_001 validate-input {"valid":true}
step_002 process-order {"order_id":"123","total":99.99}

Examples:

Terminal window
# View paused state
ironflow run paused-state run_abc123
# JSON output for scripting
ironflow run paused-state run_abc123 --json

Modify the output of a completed step while a run is paused for injection.

Terminal window
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:

ArgumentRequiredDescription
run-idYesThe paused run ID
step-idYesThe completed step ID to modify

Flags:

FlagShortTypeDefaultDescription
--outputstringNew JSON output for the step (required)
--reasonstringReason for the injection (optional)
--server-sstringServer URL override

Output:

Injected step step_002
Previous output: {"order_id":"123","total":99.99}

Examples:

Terminal window
# Inject modified output
ironflow run inject run_abc123 step_002 --output '{"order_id":"123","total":89.99}'
# Inject with a reason for the audit trail
ironflow run inject run_abc123 step_002 \
--output '{"corrected": true}' \
--reason "Fix calculation error"

Resume a paused or failed run. When resuming an injection-paused run, clears the pause state and re-dispatches from where it left off.

Terminal window
ironflow run resume <run-id> [flags]

Arguments:

ArgumentRequiredDescription
run-idYesThe run ID to resume

Flags:

FlagShortTypeDefaultDescription
--from-stepstringResume from a specific step ID
--server-sstringServer URL override

Output:

Resumed run run-abc123 (status: running)

Examples:

Terminal window
# Resume a paused run
ironflow run resume run_abc123
# Resume from a specific step
ironflow run resume run_abc123 --from-step step_002
# Typical scoped injection workflow
ironflow run pause run_abc123
ironflow run paused-state run_abc123
ironflow run inject run_abc123 step_002 --output '{"fixed": true}' --reason "correct value"
ironflow run resume run_abc123