Documentation

Pages rendered from the OpenRig repo follow the latest release, currently OpenRig 0.6.10; each ends with its source. The guide pages and the generated config, MCP and TUI tables were last checked against OpenRig 0.6.6. Every command is quoted from the running binary's help, and the generated references are produced from it directly.

Start here, in this order

New to OpenRig, or just finished the tour? Read these four in sequence. Each one ends by pointing at the next.

1. Getting started: prerequisites, install, the first three commands, and which starter to boot.
2. The terminal UI: the screen you see after rig tui, and how to move around it.
3. Messaging: how seats talk to each other, and what a send does and does not prove.
4. Coordination: assigning tasks to agents: the task queue, claims, handoffs and waiting on blockers.

Then, by topic

• Continuity: snapshots, restore, handover, compaction, agent images.
• Lifecycle: boot, grow, shrink, adopt, stop.
• Workflows: declared sequences of work, and watchdogs.
• The work tree: projects, missions, slices and proof on disk.
• Context: what a seat knows when it arrives.
• Hosts and humans: other machines, and reaching a person.
• Accounts, providers and rig environments.
• Troubleshooting: the surface that shows the truth, and the recovery command.

Reference

Generated from the running binary, so they match the version they name.

• CLI reference: how to read it, and the full command table.
• Configuration: how settings resolve, and the full key table.
• MCP tools: driving OpenRig from an MCP agent, and the full tool list.
• TUI command registry.

The specification

The formats these pages refer to have their own reference: taxonomy, AgentSpec, RigSpec, edge types, RigBundle.