Getting started

Install

curl -fsSL https://orc.sieversii.ca/install.sh | sh

The script installs orc to ~/.local/bin after checking its signature and checksum. To check a download by hand, see Verify a download.

orc needs git, tmux 3.2 or newer, and Claude Code (claude). Then install orc's hooks, so Claude Code tells orc when an agent is working or waiting, and check your machine:

orc hooks install
orc doctor

Set up a project

In a git repository:

orc init

This creates orc's context folder, kept out of git by its own .gitignore.

The flow

  1. Draft a plan. orc plan new "Add a dark theme" creates a plan, a Markdown file you edit like any other. orc plan draft opens Claude to draft it with you.
  2. Refine it. orc plan refine works through the plan's open questions with you.
  3. Start a worker. Start one from the TUI or with orc agent start. It gets a branch, a git worktree and an agent in a tmux session that keeps running when you close your terminal.
  4. Read the wrap-up. The agent records what it did, what is left and what to look at.
  5. Finish. orc plan finish runs the gates (your checks, a conflict probe, your review) and lands the work by a local merge or a pull request. The agent never merges or pushes.

Watch everything at once

orc tui

The TUI lists every plan and agent across your projects and shows which ones are waiting for you.

Stay up to date

orc update

orc update checks a new release against the keys your installed orc already trusts, then asks before it installs. orc changelog prints the release notes built into orc.

More

orc --help and orc <command> --help describe every command. The full manual will appear here when orc's releases carry it.