Local Development & CLI
Set up a local Orcher development environment
Develop and test workflows locally before deploying to production.
Prerequisites
- PostgreSQL 14+ — Workflow state and journals
- Redis 7+ — Task dispatch queues
- Rust 1.70+ / Python 3.10+ / Node.js 18+ — Depending on your SDK
Quickstart
-
Get the quickstart, which runs the engine image with Docker Compose:
1git clone https://github.com/orcher-io/quickstart.git2cd quickstart -
Start dependencies:
1docker-compose up -d postgres redis -
Run the orchestrator:
1cargo run -p orchestrator -- --config services/orchestrator/config/development.toml -
Run your worker:
1# Rust2cargo run -p my-workflow-worker34# TypeScript5npx ts-node worker.ts67# Python8python worker.py
Guides
- Local Development Setup — Full setup instructions
- Configuration & Environment — Configure your local environment
- Workflow Development — Write and iterate on workflows
- Debugging Workflows — Debug workflow execution
- Testing Workflows — Unit and integration testing