Getting Started
Install the ruah CLI and run your first multi-agent workflow in under 5 minutes.
Installation
Install the ruah CLI globally:
# pnpm (recommended)
pnpm add -g @ruah-dev/cli
# npm
npm install -g @ruah-dev/cli
# or run without installing
npx @ruah-dev/cliVerify the installation:
ruah --versionInitialize a Repository
Navigate to any git repository and initialize ruah:
cd your-project
ruah initThis creates a .ruah/ directory with configuration and state files.
Create Your First Task
Tasks are isolated workspaces where AI agents can make changes without interfering with each other:
ruah task create auth \
--files "src/auth/**" \
--executor claude-code \
--prompt "Add JWT authentication with refresh tokens"Options:
--files— glob patterns for the files this task can modify--executor— which AI agent to use (claude-code,aider,codex,open-code,script,raw)--prompt— instructions for the agent
Start the Task
ruah task start authThis creates a git worktree, sets up file claims, and launches the executor.
Complete and Merge
When the agent finishes:
# Mark as done
ruah task done auth
# Merge back to main branch
ruah task merge authThe merge runs governance gates (if configured) and integrates changes cleanly.
Run the Interactive Demo
Not sure where to start? Try the built-in demo:
ruah demoThis walks you through the full workflow interactively.
Next Steps
- CLI Reference — all commands and options
- Orchestration Concepts — workspaces, claims, workflows
- API Conversion — convert specs to agent tools