OpenRig provides a command-line interface for managing coding agents, development teams, tasks, and terminal sessions.
Whether you’re running OpenRig on Ubuntu, working with Codex or Claude Code, or managing multiple AI coding agents, knowing a few essential commands makes the system much easier to operate.
This cheat sheet covers installation checks, starting and stopping OpenRig, managing agent teams, sending instructions, monitoring tasks, and troubleshooting common problems.
Compatibility: OpenRig 0.7.10 (November 2026). Commands and flags may change between releases. Run rig --help or rig <command> --help to check your installed version.
1. OpenRig Quick Reference
These are the commands you’ll probably use most often.
| Command | Description |
|---|---|
rig --help | Display available OpenRig commands |
rig --version | Show the installed version |
rig doctor | Check the installation for problems |
rig daemon start | Start the background daemon |
rig daemon status | Check whether the daemon is running |
rig status | Display daemon, kernel and team status |
rig ps | List running rigs and sessions |
rig ps --nodes | Show individual agents and their states |
rig tui | Open the terminal dashboard |
rig up starter --cwd . | Start the built-in starter team in the current directory |
rig send <agent> "message" | Send a message to an agent |
rig queue list | List queued work |
rig down starter | Stop the starter team |
rig daemon stop | Stop the daemon, leaving agent sessions running |
Note: The built-in starter team uses Claude Code and Codex by default. If you’ve installed only one provider, ask OpenRig’s operator to adapt the team before launching it.
2. Installation and Setup Commands
Use these commands to check your installation and configure a coding provider.
| Command | Description |
|---|---|
rig --version | Verify OpenRig is installed |
rig --help | List commands |
rig setup --providers codex --dry-run | Preview Codex setup changes |
rig setup --providers codex | Configure Codex integration |
rig setup --providers claude | Configure Claude Code integration |
rig setup --providers both | Configure both providers |
rig doctor | Run installation diagnostics |
rig setup --help | View all setup options |
OpenRig normally installs Herdr TUI during setup. If you prefer plain tmux, add --no-herdr to the setup command.
For example:
rig setup --providers codex --no-herdr3. Starting and Stopping OpenRig
The OpenRig daemon maintains the coordination state for agents and teams.
Start OpenRig
rig daemon startTo bind the daemon explicitly to localhost on port 7433:
rig daemon start \
--host 127.0.0.1 \
--port 7433By default, a new daemon startup also starts OpenRig’s kernel team, including its operator.
To start without the kernel:
rig daemon start --no-kernelThe kernel is useful for guided team creation. The --no-kernel option is more appropriate when you intend to launch a predefined team yourself.
Daemon command reference
| Command | Description |
|---|---|
rig daemon start | Start OpenRig |
rig daemon start --no-kernel | Start without the kernel team |
rig daemon status | Check daemon status |
rig daemon logs | Display daemon logs |
rig daemon logs --follow | Follow live daemon logs |
rig daemon stop | Stop the daemon |
rig status --json | Return status as JSON |
Stopping the daemon does not automatically stop agent sessions.
If you want to shut everything down, inspect the running rigs, stop the project teams, stop kernel last if it is running, and then stop the daemon.
rig ps --json
rig down starter
rig down kernel
rig daemon stopOnly run rig down for rigs that actually exist. Stopping the kernel also ends the operator’s session.
4. Viewing Agents and Running Teams
OpenRig includes commands for inspecting active teams and individual agents.
| Command | Description |
|---|---|
rig ps | Show running rigs and sessions |
rig ps --nodes | Display individual agent seats |
rig ps --nodes --rig starter | Show agents in the starter team |
rig ps --running | Filter for running entries |
rig ps -A | List entries across all rigs |
rig ps --json | Return session information as JSON |
rig tui | Open the terminal dashboard |
Find an agent’s terminal session
When connected over SSH, use:
rig ps --nodes --rig starter --json \
--fields logicalId,canonicalSessionName,tmuxAttachCommandThe output includes the session name and attachment command for each agent.
Copy the reported tmuxAttachCommand into your terminal to connect to the agent.
This is particularly useful on headless Ubuntu servers.
Useful tmux keyboard shortcuts
When attached to an agent session, these tmux shortcuts are helpful:
| Shortcut | Action |
|---|---|
Ctrl+B, then D | Detach without terminating the session |
Ctrl+B, then C | Create a tmux window |
Ctrl+B, then N | Switch to the next window |
Ctrl+B, then P | Switch to the previous window |
Ctrl+B, then [ | Enter scrollback mode |
Ctrl+B, then ? | Display tmux key bindings |
Detach from an agent session when you want to return to your normal shell without interrupting the agent.
5. Starting and Managing Agent Teams
A group of coding agents managed by OpenRig is called a rig.
Preview a starter team.
From a project directory:
rig up starter --cwd . --planThe --plan flag previews the launch without starting the team.
Start the starter team
rig up starter --cwd .If your team has a custom YAML configuration, use its file path:
rig up ./rig.yaml --plan
rig up ./rig.yamlTeam management commands
| Command | Description |
|---|---|
rig up starter --cwd . --plan | Preview starter-team creation |
rig up starter --cwd . | Start the built-in starter team |
rig up ./rig.yaml | Start a team from a YAML specification |
rig up starter --existing | Resume an existing starter rig |
rig ps --nodes --rig starter | Inspect the starter team |
rig down starter | Stop the starter team’s sessions |
rig spec show starter | Inspect the recorded starter specification |
rig specs ls --include-builtins | List available specifications, including built-ins |
Replace starter with your rig’s actual name when using a custom configuration.
6. Communicating With Coding Agents
OpenRig lets you send instructions directly to an agent without manually switching terminal sessions.
Send a message
rig send dev-build@starter \
"Please review the website's current HTML structure."This targets the builder seat in the starter rig.
Ask an agent for a status update
rig send dev-build@starter \
"Summarise your progress and any outstanding issues."Request a review
rig send dev-review@starter \
"Review the latest changes for bugs and regressions."The exact agent addresses depend on the team configuration. Find them with:
rig ps --nodes --rig starterOther communication commands
| Command | Description |
|---|---|
rig send <agent> "message" | Send a direct instruction |
rig ask starter "question" | Ask a question through the rig |
rig chatroom send starter "message" | Post a team chatroom message |
rig chatroom history starter | Read the team chatroom history |
rig transcript <agent> --tail 50 | View recent conversation transcript lines |
A message sent using rig send is not automatically a formal tracked task. Use the queue commands below when work needs a persistent task record.
7. Managing Tasks and Queued Work
OpenRig includes a queue system to record, assign, and track work.
List work assigned to an agent
rig queue list \
--destination dev-build@starterCreate a tracked task
rig queue create \
--destination dev-build@starter \
--summary "Improve website navigation" \
--body "Review the navigation and implement the agreed accessibility changes."The command returns a task identifier.
Use that identifier when inspecting the task.
Task management reference
| Command | Description |
|---|---|
rig queue list | List queued tasks |
rig queue list --all | Include additional task states |
rig queue list --destination dev-build@starter | Show work assigned to the builder |
rig queue show <task-id> | Display a task |
rig queue show <task-id> --full | Display full task details |
rig queue transitions <task-id> | View task state transitions |
rig queue overdue | List overdue work |
rig queue undelivered | Identify work that has not been delivered |
rig queue list --json | Return queue data in JSON |
For small tasks, a direct instruction may be sufficient. Use the queue when you need an assignment, recorded state, and a work history.
8. Validating Team Configuration Files
Advanced OpenRig configurations use YAML files to define teams and agent profiles.
Before launching a custom team, validate its configuration.
Validate an agent definition
rig agent validate ./agents/worker/agent.yamlValidate a rig specification
rig spec validate ./rig.yamlRun a preflight check
rig spec preflight ./rig.yamlPreview the launch
rig up ./rig.yaml --planThese checks help diagnose invalid YAML structure, unresolved references, or missing startup files.
Validation and preflight have different purposes. A syntactically valid specification does not guarantee that the selected coding provider can authenticate or that every seat will launch successfully.
9. Troubleshooting and Diagnostics
If OpenRig behaves unexpectedly, start with the status and diagnostic commands.
| Command | Description |
|---|---|
rig doctor | Run general diagnostics |
rig daemon status | Check daemon availability |
rig daemon logs | Read daemon logs |
rig daemon logs --follow | Watch new log messages |
rig status | Inspect overall state |
rig ps --nodes | Identify agent startup problems |
rig health | View health findings |
rig health --rig starter | Inspect health for one rig |
rig health explain <finding-id> | Explain a health finding |
rig config | Display effective configuration |
rig config get <key> | Inspect an individual setting |
When an agent stops during startup
OpenRig may report a partial launch when an agent waits for authentication, a workspace-trust decision, or a permission prompt.
Inspect the existing agent terminal, answer the prompt, and use the continuation command OpenRig shows.
The general form is:
rig seat continue <seat>Use the actual seat address from the startup message.
When the SQLite database produces an ownership warning
If OpenRig reports that it could not verify who owns its SQLite database, inspect the running processes before making changes.
For a default installation under a rigdev account:
pgrep -af 'openrig|rig.*daemon'
timeout 10s lsof -nP -- \
/home/rigdev/.openrig/openrig.sqliteAn lsof result showing the expected daemon PID confirms that the process has the file open. It does not prove that another process never accessed it.
Do not delete the SQLite database or its journal files to clear a warning.
10. Monitoring Usage
OpenRig includes commands for inspecting usage and cost-related information.
| Command | Description |
|---|---|
rig usage top | Show usage leaders |
rig usage cost | Display cost information |
rig usage cost --seat dev-build@starter | Show cost information for a specific seat |
rig usage series | Inspect usage over time |
Usage data depends on the providers and information available to OpenRig. Treat it as operational visibility rather than a guaranteed reconciliation with the provider’s bill.
11. Useful JSON Commands
Many OpenRig commands support --json, which is convenient when using shell scripts or jq.
For example:
rig status --jsonCheck the running agents in JSON format:
rig ps --nodes --jsonInspect queued work:
rig queue list --jsonJSON is useful for automating reporting, but the fields vary between commands and releases. Inspect the returned structure before writing scripts that depend on it.
12. Example: A Typical OpenRig Development Session
Here’s a simple command sequence for working on a website.
Check the installation
rig --version
rig doctorStart the daemon
rig daemon start
rig statusNavigate to your project
cd ~/projects/my-first-websitePreview the team
rig up starter --cwd . --planIf you have the required providers configured, start the team:
rig up starter --cwd .Inspect the agents
rig ps --nodes --rig starterAssign a task
rig send dev-build@starter \
"Improve the website's responsive layout and ask the reviewer to inspect the changes."Monitor the work
rig queue list --destination dev-build@starter
rig ps --nodes --rig starterReview the source changes
From the project directory:
git status --short
git diff --check
git diffReview and test changes before approving a commit or deployment.
Stop the team
rig down starterStop the daemon when you no longer need it:
rig daemon stopIf the kernel is running and you want a complete shutdown, stop it after your project rigs and before stopping the daemon.
13. Commands and Practices to Remember
A few operating rules will prevent common mistakes:
- Check before launching. Use
rig up ... --planto inspect what OpenRig intends to start. - Inspect agent readiness. A running daemon does not guarantee all agents are ready.
- Know the session addresses. Use
rig ps --nodesbefore sending commands to a named agent. - Understand shutdown behavior.
rig daemon stopLeaves agent sessions running;rig downstops the selected rig. - Protect project credentials. Avoid giving agent accounts unnecessary access to production systems.
- Review code before deployment. A completed agent task is not the same as a tested release.
Official OpenRig Documentation
For command flags, new features, and version-specific behavior, consult the project’s official documentation:
- OpenRig documentation
- OpenRig CLI reference
- Complete command reference
- OpenRig GitHub repository
- OpenRig release history
The installed CLI is the final authority on supported options:
rig --help
rig <command> --helpFinal tip: Start with rig status, rig ps, rig tui, rig send and rig down. Those commands cover most everyday interactions with a running OpenRig team. Add the queue, configuration, and diagnostic commands as your projects become more complex.

Leave a Reply