Orcher CLI Reference
Complete reference documentation for the Orcher CLI (orcher). Manage workflows, namespaces, queues, and server processes from your terminal.
Installation
Using Cargo
1cargo install orcher-cliVerify Installation
1orcher --versionQuick Start
1# Create a new project2orcher new project my-app34# Configure a server context5orcher config set-context local --server http://localhost:808067# Start the server8orcher server start --foreground910# Run a workflow11orcher run my-workflow --param order_id=123Global Flags
These flags apply to all commands:
| Flag | Environment Variable | Default | Description |
|---|---|---|---|
--config | ORCHER_CONFIG | ~/.orcher/config.yaml | Config file path |
--context | ORCHER_CONTEXT | local | Context to use |
-n, --namespace | ORCHER_NAMESPACE | default | Namespace |
-o, --output | — | table | Output format: table, json, yaml, name, wide |
-v, --verbose | ORCHER_VERBOSE | false | Enable debug logging |
-q, --quiet | ORCHER_QUIET | false | Suppress non-essential output |
--no-color | NO_COLOR | false | Disable colored output |
--server | ORCHER_SERVER | — | Override server URL |
--api-url | ORCHER_API_URL | --server host on port 8080 | REST API address (the engine's HTTP port) |
--redis-url | ORCHER_REDIS_URL | — | Redis URL for DLQ operations |
Next Steps
- Project & Development Commands —
orcher new,orcher run,orcher test,orcher dev - Workflow Commands —
orcher workflow,orcher describe,orcher logs,orcher status - Infrastructure Commands —
orcher server,orcher namespace,orcher queue - Configuration & Auth —
orcher config,orcher auth,orcher completion, config file reference - Examples & Troubleshooting — Common workflows, debugging tips, and command summary