CLI Reference — Registered Commands and Options

Verified against source commit e8f0ab340db773392ec8be75b072d1c0f3068a50. The inventory below comes from the actual Commander tree returned by createProgram(), not a grep of command strings or an installed CLI from a different commit.

There are 87 top-level registrations, 356 registered command objects below rig (including groups and the hidden restore apply command), and 1,082 explicitly registered option objects, including the root version option. Aliases do not add command objects; short/long spellings of one option do not add option objects. Commander-generated help is additional. These are source counts, not a claim about a deployed release.

Reading this reference

Each table row lists one registered command, its positional arguments, command aliases, and its own declared options. <value> denotes a required positional/option value; [value] is optional; ... is variadic. An option marked required was registered with Commander's mandatory option setting. An option marked (repeatable) collects every value when it is given more than once. Conditional requirements enforced by an action are not encoded by this inventory.

Use rig <command> --help for descriptions, choices, defaults, and examples. Defaults may depend on the current directory, configuration, or action code; they are not fixed by the flags table. Parent command options are listed on the parent row, not repeated on every child. The root declares -V, --version; Commander also provides -h, --help and applicable help [command] handling. The only explicit command alias at this pin is rig host ls for host list.

An option named --json selects the command's JSON mode; it does not imply that every verb shares one response schema. The handler and its daemon route remain the source for result/error shape and side effects.

Entry points and practical routes

Bare rig opens the TUI, the status dashboard rather than an agent conversation, when both stdin and stdout are terminals. Arguments, pipes, and redirected streams follow normal CLI parsing. runFrontDoor and openMissionControl own the entry behavior; tuiCommand owns explicit TUI options; rig terminal open saved:kernel --window opens a terminal view of the OpenRig TUI, the operator and the advisor (in a new tab or window, or the current Herdr session), and rig tui --shared is the dashboard-only fallback when that view cannot open. A daemon-down transport result can still open the recovery cockpit; it is not automatically a reason to exit before rendering.

Do not confuse rig project's coordination/classification surface with rig scope's project and work-tree commands. Likewise, rig spec manages rig specifications, rig specs browses the spec library, and rig workflow specs lists workflow specifications. The tree below preserves those distinct registrations.

A successful read, queue admission, terminal delivery, proof judgment, and publication are different operations. Consult the relevant command handler and workflow runtime when deciding what a result establishes. This reference does not turn an inventory entry into permission to perform that operation.

Reproducing the registration inventory

In a development checkout at the stamped commit, after installing its locked dependencies and building the daemon and CLI, this import walks the registered tree without parsing arguments or invoking command actions:

node --input-type=module <<'JS'
import { createProgram } from './packages/cli/dist/index.js';
const root = createProgram();
const rows = [];
function walk(command, prefix = '') {
  const path = prefix ? `${prefix} ${command.name()}` : command.name();
  rows.push({
    path,
    aliases: command.aliases(),
    arguments: command.registeredArguments.map(a => ({
      name: a.name(), required: a.required, variadic: a.variadic,
    })),
    options: command.options.map(o => ({
      flags: o.flags, required: Boolean(o.mandatory),
    })),
  });
  for (const child of command.commands) walk(child, path);
}
walk(root);
console.log(JSON.stringify({
  topLevel: root.commands.length,
  registeredCommands: rows.length - 1,
  declaredOptions: rows.reduce((n, row) => n + row.options.length, 0),
  rows,
}, null, 2));
JS

This inspects registration, not action semantics or availability of a running daemon. index.ts imports the command factories; their implementations live in packages/cli/src/commands/. The tables below retain registration order. Only the command/argument/alias/ option cells are mechanically transcribed; the explanations above are authored.

Registered command tree

Root: rig; declared option: -V, --version.

start

daemon

status

snapshot

restore

crash-cart

gateway

parked

export

import

ui

tui

package

bootstrap

requirements

discover

attach

bind

adopt

bundle

up

down

archive

unarchive

host

ps

roster

mcp

agent

spec

transcript

send

stream

queue

slack

project

view

terminal

watchdog

workflow

capture

broadcast

walk

ask

chatroom

specs

context

plugin

skill

agent-image

fork

workspace

mode

policy

whoami

config

• init-workspace — rig config init-workspace creates missing missions/, exhaust/, SPEC.md, project.yaml, workspace.yaml, and .gitignore entries at the configured workspace root (or --root <path>). Initialization is additive and preserves existing files; a complete six-entry scaffold is a no-op. --force is deprecated compatibility and still preserves existing files. --dry-run reports planned additions without writing; incompatible path types are reported before any writes.

file

preflight

auth

provider

usage

telemetry

health

doctor

expand

add

create

grow

reconcile-session

env

unclaim

release

launch

remove

shrink

destroy

setup

restore-check

restore-packet

compact-plan

compact

heartbeat

seat

handover

startup-proof

scope

proof