docs

Quickstart

Five commands from zero to first run. Full reference docs land soon.

1 · Install the runner

The runner ships as a signed, single-file binary (no Node toolchain required). Sign in to your account to get a one-time install command tailored to your subscription:

Get install command →

The install command looks like curl -fsSL https://pipemason.com/install/<token> | bash — it detects your OS + arch, drops the binary in $HOME/.local/bin/pipemason, and self-verifies. The token is single-use and expires in 15 minutes.

2 · Pair your runner

Open pipemason login, enter the code from your terminal at pipemason.com/pair, and the runner is bound to your account.

pipemason login

3 · Initialize a target repo

Pipemason auto-detects your domains (web / api / mobile / db / cloud) from package.json, Podfile, and friends, and pre-fills .pipeline/config.yml.

cd ~/your-repo
pipemason init
git add .pipeline/ && git commit -m "init pipemason workspace"

4 · Set your Anthropic key

Pipemason is BYO Anthropic. The runner reads the key from your shell — we never see it.

export ANTHROPIC_API_KEY=sk-ant-...

5 · Start a run

pipemason start "ABC-1234 add passkey login"

Watch the live monitor at pipemason.com/dashboard as the agent chain runs. When it finishes you have a tested branch with atomic commits ready to review.

What lives where

  • .pipeline/config.yml — repo-level config (domains, commands, model tiering, gates)
  • .pipeline/STATE.md — current run state (monitor owns)
  • .pipeline/spec.md — frozen spec from your input
  • .pipeline/contracts/ — frozen interfaces between domains
  • .pipeline/iterations.log — append-only audit trail

More references — full state machine, agent prompts, architecture notes — land here as we expand the docs site.

pipemason