Skip to content
Rigg

Getting started

Install

Section titled “Install”
Terminal window
curl -fsSL https://tryrigg.com/install | bash

Specific version:

Terminal window
curl -fsSL https://tryrigg.com/install | bash -s -- --version v0.1.0

Upgrade an installed release binary:

Terminal window
rigg upgrade
rigg upgrade v0.1.0

macOS only (prebuilt binary).

Requirements: codex on PATH and codex-cli 0.114.0 or newer for codex steps. claude on PATH for claude steps (claude login to authenticate). opencode on PATH for opencode steps (opencode --version to verify installation).

rigg upgrade only works from an installed release binary, not from bun run.

Init and run

Section titled “Init and run”
Terminal window
rigg init                              # creates .rigg/ with example workflows
rigg list                              # list workflows in the current project
rigg validate                          # check YAML syntax
rigg run hello --input name=Rigg       # run a workflow
rigg run hello --auto-continue         # skip step barriers in the TTY UI
rigg run hello --headless              # run without the TTY UI
rigg run hello --headless --output-format json

--input key=value auto-parses JSON — true, 42, ["a"], {"x":1} all work.

Rigg also keeps local run history when the history database is available:

Terminal window
rigg history
rigg show <run_id>
rigg logs [run_id] [step]

Running workflows

Section titled “Running workflows”

rigg run opens an interactive terminal UI by default. That mode requires both stdin and stderr to be attached to a TTY. The UI switches between a live running view, a waiting view for barriers and interactions, and a final result view. During codex, claude, and opencode steps, the running view shows live agent activity such as assistant text and tool progress. Use continue or abort at barriers, and use Ctrl-C to interrupt the active step.

With --auto-continue, step barriers advance automatically while approvals, questions, and other input prompts still pause normally.

Use --headless in scripts, CI, or other non-interactive environments. Headless runs skip the TTY requirement, auto-continue step barriers, and write output directly to stdout/stderr. --output-format json emits one final summary object, and --output-format stream-json emits one JSON event per line plus a final summary record. In headless mode, required inputs must already be available via --input or workflow defaults.

When the local history database is available, completed runs are recorded so rigg list, rigg history, rigg show, and rigg logs can inspect them later.