CLI reference

Documented against OpenRig 0.5.14. Help text uses "node" where these pages say seat, for a seat's position in the running rig.

What it is for

rig is the one command both people and agents use to operate OpenRig. It is readable by default and most commands take --json for agents. Every command that changes something ends by telling you what happened, the current state and a sensible next step. Every error says what happened, why it is a problem and what to do next. The surface is large and grows from release to release, so the reference below is generated from the running binary's help rather than written by hand, and it names the version and commit it was generated from.

How to read it

The full reference is generated: see generated/cli-reference.md (85 top-level verbs, 320 command paths, 1,270 options on 0.5.14). Each command lists the options its own help shows; parent and global options are listed separately. Hidden commands and the synthetic help subcommand are omitted. Description-less help rows are retained and labelled, so they are not missing commands.

Two habits make it useful. rig --help lists the installed top-level commands; read that list before building anything, because the most expensive failure is a script that re-implements a verb. rig <verb> --help is always more current than any page, including this one.

The verbs by job

• Finding out what is true right now: whoami, ps, status, queue whoami, seat status, view, config, health.
• Reaching another seat: send, capture, broadcast, transcript, ask, chatroom, walk, terminal. See Messaging.
• Work that outlives a turn: queue, stream, view, project. See Coordination.
• Being woken: watchdog. Running a pipeline: workflow. See Workflows.
• Bringing rigs and seats into and out of existence: up, down, launch, add, remove, expand, shrink, grow, create, fork, archive, attach, bind, adopt, discover, release. See Lifecycle.
• Surviving: snapshot, restore, restore-check, restore-packet, handover, seat, compact-plan, compact, agent-image. See Continuity.
• Work on disk: scope, proof, workspace. See the work tree.
• Knowledge for seats: context, skill, plugin. See Context.
• Other machines and people: host, file, gateway, slack. Accounts and services: auth, provider, env.
• When something is broken: doctor, preflight, daemon, start, crash-cart, destroy, heartbeat, parked.

Help uses "node" where these pages say seat, for a seat's position in the running rig; the generated reference quotes help verbatim.

What it does not do

• The reference does not describe effects that were never executed. It is help text, faithfully copied and checked for completeness against an independent traversal of the help tree.
• Exit codes and daemon requirements are per command; the general rule is that most commands need a running daemon, and daemon, config, preflight and doctor work without one.

Where it goes next

Each family page above. The Specs pages for spec, specs, bundle, export and import.