Reference

Project & Development Commands


orcher new (alias: n)

Create new projects, workflows, or tasks from templates.

new project

1
orcher new project <name> [OPTIONS]
2
3
# Examples
4
orcher new project my-app
5
orcher new project my-app --template microservices --dir ./projects
OptionDefaultDescription
-t, --templatebasic-workflowTemplate: basic-workflow, microservices, data-pipeline, batch-processing
-d, --dircurrent directoryOutput directory

new workflow

1
orcher new workflow <name> [OPTIONS]
2
3
# Examples
4
orcher new workflow process-order
5
orcher new workflow process-order --type dag --output src/workflows/
OptionDefaultDescription
-t, --typesequentialWorkflow type: sequential, parallel, dag, conditional
-o, --output—Output file path

orcher run

Run a workflow locally or remotely.

1
orcher run <workflow_type[@task_queue]> [OPTIONS]
2
3
# Examples
4
orcher run process-order --param order_id=123 --param amount=99.99
5
orcher run payment-workflow@payment-tasks --param data='{"foo":"bar"}'
6
orcher run batch-job --local --env staging

The workflow identifier format is workflow_type[@task_queue]. If @task_queue is omitted, the workflow type is used as the queue name.

OptionDescription
--localRun locally instead of on cluster
-e, --envEnvironment to run against
-p, --paramParameters as key=value (repeatable; supports JSON values)

Parameter types: The --param flag auto-detects types. Integers, floats, booleans, strings, JSON objects, and JSON arrays are all supported:

1
orcher run my-workflow \
2
--param count=42 \
3
--param price=9.99 \
4
--param active=true \
5
--param name=hello \
6
--param config='{"key":"value"}' \
7
--param items='[1,2,3]'

orcher test

Test workflows locally.

1
orcher test <workflow_file> [OPTIONS]
2
3
# Examples
4
orcher test src/workflows/order.rs
5
orcher test src/workflows/order.rs --dry-run
6
orcher test src/workflows/ --watch --env staging
OptionDescription
--dry-runValidate without executing
-e, --envEnvironment to test against
-w, --watchWatch for file changes and re-test

orcher dev

Development mode commands.

dev start

1
orcher dev start [OPTIONS]
2
3
# Examples
4
orcher dev start
5
orcher dev start --port 9090 --host 0.0.0.0
OptionDefaultDescription
--port8080Dev server port
--hostlocalhostDev server host

dev stop

1
orcher dev stop

dev logs

1
orcher dev logs [--follow]