Skip to content

CLI

The orch8 CLI provides admin operations against a running engine. All commands communicate with the REST API.

Instance management

# List instances
orch8 instances list --tenant acme --state scheduled --limit 50

# Get instance state
orch8 instances get <instance-id>

# Send a signal
orch8 instances signal <instance-id> pause
orch8 instances signal <instance-id> resume
orch8 instances signal <instance-id> cancel
orch8 instances signal <instance-id> update-context '{"replied": true}'

# Bulk cancel by filter
orch8 instances bulk-cancel --namespace production --state paused

Sequence management

# List sequences
orch8 sequences list --tenant acme

# Get a sequence definition
orch8 sequences get <sequence-id>

# List versions
orch8 sequences versions <sequence-name>

# Deprecate a version
orch8 sequences deprecate <sequence-id>

Cron management

# List cron schedules
orch8 cron list --tenant acme

# Enable/disable a schedule
orch8 cron enable <cron-id>
orch8 cron disable <cron-id>

Checkpoints

# List checkpoints for an instance
orch8 checkpoints list <instance-id>

# Prune old checkpoints (keep last N)
orch8 checkpoints prune <instance-id> --keep 5

Health checks

# Liveness
orch8 health live

# Readiness (DB connectivity check)
orch8 health ready

# Circuit breaker status
orch8 circuit-breakers list
orch8 circuit-breakers reset <handler-name>