Reference

Orcher CLI Reference


Complete reference documentation for the Orcher CLI (orcher). Manage workflows, namespaces, queues, and server processes from your terminal.

Installation

Using Cargo

1
cargo install orcher-cli

Verify Installation

1
orcher --version

Quick Start

1
# Create a new project
2
orcher new project my-app
3
4
# Configure a server context
5
orcher config set-context local --server http://localhost:8080
6
7
# Start the server
8
orcher server start --foreground
9
10
# Run a workflow
11
orcher run my-workflow --param order_id=123

Global Flags

These flags apply to all commands:

FlagEnvironment VariableDefaultDescription
--configORCHER_CONFIG~/.orcher/config.yamlConfig file path
--contextORCHER_CONTEXTlocalContext to use
-n, --namespaceORCHER_NAMESPACEdefaultNamespace
-o, --output—tableOutput format: table, json, yaml, name, wide
-v, --verboseORCHER_VERBOSEfalseEnable debug logging
-q, --quietORCHER_QUIETfalseSuppress non-essential output
--no-colorNO_COLORfalseDisable colored output
--serverORCHER_SERVER—Override server URL
--api-urlORCHER_API_URL--server host on port 8080REST API address (the engine's HTTP port)
--redis-urlORCHER_REDIS_URL—Redis URL for DLQ operations

Next Steps