Reference

Infrastructure Commands


orcher server

Manage the Orcher server process.

server start

1
orcher server start [OPTIONS]
2
3
# Examples
4
orcher server start --foreground
5
orcher server start --grpc-port 50051 --http-port 8080
6
orcher server start --database-url postgresql://localhost/orcher
OptionDefaultDescription
-c, --config—Server config file path
--grpc-port50051gRPC server port
--http-port8080HTTP port: the engine's REST API, health checks and metrics
--host127.0.0.1Host address to publish the ports on
-f, --foregroundfalseRun in foreground (not daemonized)
--database-urlenv DATABASE_URLPostgreSQL connection string
--log-levelinfoLog level: trace, debug, info, warn, error

server stop

1
orcher server stop [OPTIONS]
2
3
# Examples
4
orcher server stop
5
orcher server stop --force --timeout 10
OptionDefaultDescription
-f, --forcefalseForce shutdown
--timeout30Graceful shutdown timeout (seconds)

server status

1
orcher server status [OPTIONS]
2
3
# Examples
4
orcher server status
5
orcher server status --verbose --output json
OptionDefaultDescription
-v, --verbosefalseShow detailed status
-o, --outputtableOutput format
--grpc-addrhttp://localhost:50051gRPC address to check
--orchestrator-httphttp://localhost:8080Engine HTTP health address

server restart

1
orcher server restart [OPTIONS]
OptionDescription
-f, --forceForce restart

server version

1
orcher server version

Shows version information for the CLI and the running engine.


orcher namespace (alias: ns)

Manage namespaces for multi-tenancy.

namespace create

1
orcher namespace create <name> [OPTIONS]
2
3
# Examples
4
orcher namespace create production
5
orcher namespace create staging --description "Staging env" --retention-days 14 --owner-email team@example.com
6
orcher namespace create dev --data env=development --data tier=free
OptionDefaultDescription
-d, --description—Human-readable description
-r, --retention-days7Data retention period
-e, --owner-email—Owner email
--data—Key-value metadata (repeatable)

namespace list

1
orcher namespace list [OPTIONS]
OptionDefaultDescription
-l, --limit100Max results
--offset0Pagination offset

namespace get (aliases: describe, info)

1
orcher namespace get <name>

namespace update

1
orcher namespace update <name> [OPTIONS]
2
3
# Example
4
orcher namespace update staging --retention-days 30 --owner-email newteam@example.com
OptionDescription
--descriptionUpdated description
--owner-emailUpdated owner email
--retention-daysUpdated retention period
--dataUpdated key-value metadata

namespace deprecate

1
orcher namespace deprecate <name> [--force]

namespace delete

1
orcher namespace delete <name> [--force]

orcher queue (alias: q)

View and manage task queues.

queue list

1
orcher queue list [OPTIONS]
2
3
# Examples
4
orcher queue list
5
orcher queue list --queue payment-tasks --all-namespaces
OptionDefaultDescription
-Q, --queue—Filter by queue name
-A, --all-namespacesfalseShow across all namespaces
-l, --limit50Max results

queue stats

1
orcher queue stats <queue_name> [OPTIONS]
2
3
# Example
4
orcher queue stats payment-tasks --type payment-workflow
OptionDescription
-t, --typeFilter by workflow type

queue depth

1
orcher queue depth [queue_name] [OPTIONS]
2
3
# Examples
4
orcher queue depth payment-tasks
5
orcher queue depth --watch --interval 5
OptionDefaultDescription
-w, --watchfalseContinuous monitoring mode
--interval2Watch update interval (seconds)

queue pollers

1
orcher queue pollers <queue_name> [OPTIONS]
OptionDescription
-v, --verboseShow detailed poller information