Local Development

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

  1. Get the quickstart, which runs the engine image with Docker Compose:

    1
    git clone https://github.com/orcher-io/quickstart.git
    2
    cd quickstart
  2. Start dependencies:

    1
    docker-compose up -d postgres redis
  3. Run the orchestrator:

    1
    cargo run -p orchestrator -- --config services/orchestrator/config/development.toml
  4. Run your worker:

    1
    # Rust
    2
    cargo run -p my-workflow-worker
    3
    4
    # TypeScript
    5
    npx ts-node worker.ts
    6
    7
    # Python
    8
    python worker.py

Guides