Installation
Prerequisites
- Rust 1.94+ (see
rust-versionin Cargo.toml) - A running PostgreSQL instance (for production; in-memory store available for development)
Add dependencies
Add the crates you need to your Cargo.toml:
[dependencies]
ironflow-engine = "0.1" # Workflow handler, context, engine
ironflow-api = "0.1" # REST API server
ironflow-worker = "0.1" # Background worker
ironflow-store = "0.1" # Storage backends
ironflow-core = "0.1" # Shell, agent providers
Minimal project structure
A typical Ironflow project has three parts:
- A library crate with your workflow handlers
- A server binary that exposes the API and serves the dashboard
- A worker binary that executes workflows
my-project/
├── src/
│ └── lib.rs # Your workflow handlers
├── src/bin/
│ ├── server.rs # API server
│ └── worker.rs # Background worker
└── Cargo.toml
See the example server and example worker for complete working code.