Reference

Workflow Commands


orcher workflow (alias: wf)

Manage workflow executions.

workflow list

1
orcher workflow list [OPTIONS]
2
3
# Examples
4
orcher workflow list
5
orcher workflow list --status running --limit 10
6
orcher workflow list --all-namespaces --output json
7
orcher workflow list --type process-order --query "status=failed"
OptionDefaultDescription
-t, --type—Filter by workflow type
-s, --statusallFilter: running, completed, failed, cancelled
-l, --limit50Max results
-A, --all-namespacesfalseShow across all namespaces
--query—Advanced filter expression

workflow get

1
orcher workflow get <workflow_id> [OPTIONS]
2
3
# Examples
4
orcher workflow get wf-abc123
5
orcher workflow get wf-abc123 --execution-id exec-456 --full
OptionDescription
-e, --execution-idSpecific execution ID
--fullShow full execution details

workflow cancel

1
orcher workflow cancel <workflow_id> [OPTIONS]
2
3
# Examples
4
orcher workflow cancel wf-abc123
5
orcher workflow cancel wf-abc123 --reason "Duplicate order" --force
OptionDescription
-e, --execution-idSpecific execution ID
-r, --reasonCancellation reason
-f, --forceSkip confirmation prompt

workflow terminate

1
orcher workflow terminate <workflow_id> [OPTIONS]
2
3
# Examples
4
orcher workflow terminate wf-abc123 --reason "Stuck in bad state" --force
OptionDefaultDescription
-e, --execution-id—Specific execution ID
-r, --reason"Terminated via CLI"Termination reason
-f, --forcefalseSkip confirmation

workflow reset

Rewind a workflow to a specific journal point and re-execute from there.

1
orcher workflow reset <workflow_id> --event-id <target_event_id> [OPTIONS]
2
3
# Examples
4
orcher workflow reset wf-abc123 --event-id 5 --reason "Bad deployment"
5
orcher workflow reset wf-abc123 --event-id 3 -e exec_def456
OptionDefaultDescription
--event-id (required)—Journal event ID to reset to
-e, --execution-idlatestSpecific execution ID to reset
-r, --reason"Reset via CLI"Reason for the reset (recorded in journal)
-f, --forcefalseSkip confirmation

The command creates a new execution that replays journal events up to the target event ID, then continues from that point. Use workflow history to find the event ID you want to reset to.

workflow history (aliases: journal, events)

View the execution journal for a workflow.

1
orcher workflow history <workflow_id> [OPTIONS]
2
3
# Examples
4
orcher workflow history wf-abc123
5
orcher workflow history wf-abc123 --compact --limit 20
OptionDefaultDescription
-e, --execution-id—Specific execution ID
-l, --limit100Max events
--compactfalseCompact output format

workflow event

Send an event (signal) to a running workflow.

1
orcher workflow event <workflow_id> --name <event_name> [OPTIONS]
2
3
# Examples
4
orcher workflow event wf-abc123 --name approval --payload '{"approved": true}'
OptionDescription
-n, --nameEvent name (required)
-p, --payloadEvent payload as JSON string

orcher describe (alias: desc)

Show detailed information about a resource.

1
orcher describe <resource_type> <name>
2
3
# Examples
4
orcher describe workflow process-order
5
orcher describe task send-email
6
orcher describe execution exec-abc123

Supported resource types: workflow/workflows/wf, task/tasks, execution/executions/exec


orcher logs

View workflow execution logs.

1
orcher logs <resource> [OPTIONS]
2
3
# Examples
4
orcher logs wf-abc123
5
orcher logs wf-abc123 --follow
6
orcher logs wf-abc123 --journal --tail 50
7
orcher logs wf-abc123 --tasks --since 1h
OptionDefaultDescription
-f, --followfalseFollow log output in real-time (text logs only)
--since—Show logs since time or duration (e.g., 1h, 30m)
--tail100Number of lines from the end
--journalfalseShow execution journal/history
--tasksfalseShow task execution details

orcher status

Show the status of resources in the current namespace.

1
orcher status [resource_type] [OPTIONS]
2
3
# Examples
4
orcher status
5
orcher status workflow
6
orcher status --all
OptionDescription
-A, --allShow all resource types