How to install mvschwarz/openrig. Official installation instructions. Project installation guide. Framework or library installation. Build installation instructions. How to setup and install from GitHub. Installation steps and setup instructions. Official docs and installation instructions GitHub.
mvschwarz/openrig Installation Guide
How to install mvschwarz/openrig. Official project installation instructions and setup guide.
⚡
Automated Install (Recommended)
Quick installation instructions for mvschwarz/openrig. This is the fastest way to complete project installation and setup.
Install via curl
curl -fsSL https://hexmos.com/ipm-install | bash &&
ipm i mvschwarz/openrigor
Install via npx
npx @hexmos/ipm i mvschwarz/openrigPrerequisites
Node.js
runtimeVersion: 20, 22, or 24
tmux
runtimeVersion: latest
codex
toolVersion: latest
Manual Installation Methods
Manual installation instructions. How to install from GitHub source.
Install with npm
npm install -g @openrig/cli
rig setup --dry-runInstall with Bun
bun add -g @openrig/cli
rig setup --dry-runInstall from Source
git clone https://github.com/mvschwarz/openrig.git
cd openrig
npm install -g
rig setup --dry-runPost Installation Steps
- Review setup's plan before applying `rig setup`.
- Before launching, ask your agent to configure your chosen permissions.
- Check prerequisites in your launch shell: `tmux -V`, `codex --version`, `codex login status`.
- Resolve missing tools or login before continuing.
- From your repository, inspect the plan before launching: `rig up first-project --cwd . --plan`
- Launch the rig: `rig up first-project --cwd .`
- Access the TUI: `rig tui --shared`
- Check project-seat readiness: `rig ps --nodes --rig first-project`
- Assign work to the owner: `rig send dev-owner@first-project 'Implement <one useful change>. Track the task in the queue and return its ID. Keep it local, verify the behavior, ask dev-check@first-project to check the exact candidate, and record the result and how I can try it.'`