Skip to content

Installation Guide

Comprehensive installation instructions for Ralph Orchestrator.

Prerequisites

  • OS: macOS, Linux, or Windows
  • Node.js: 18+ (required for npm installs)
  • Rust: 1.70+ (required for cargo installs)
  • Homebrew: required for the Homebrew method

Installation Methods

npm install -g @ralph-orchestrator/ralph-cli

Method 2: Homebrew (macOS/Linux)

brew install ralph-orchestrator

Method 3: Cargo

cargo install ralph-cli

Method 4: Prebuilt Binary (cargo-dist)

Download the latest release artifact for your OS/arch from GitHub Releases (built with cargo-dist), then place it on your PATH.

# Example (replace with the correct archive for your platform)
mkdir -p ~/bin
curl -L -o ralph.tar.gz "<release-archive-url>"
tar -xzf ralph.tar.gz
mv ralph ~/bin/
export PATH="$HOME/bin:$PATH"

Verify Installation

ralph --version

Next Steps

  • Install at least one supported AI backend CLI (Claude Code, Gemini CLI, Copilot CLI, etc.)
  • Configure your backend API keys or auth
  • Follow the quick start guide: getting-started/quick-start.md