Start

breakaway docs

Everything you need to run a breakaway board: the concepts, the CLI and the API, how agents work, how deploys and updates go, and what to do when something breaks.

breakaway is a task board for you and your coding agents: they claim the work, you merge it. It runs on your own Cloudflare account, tracks one repository or several, can run the infrastructure they run on too (Architect: nothing changes without your approval or inside bounds you approved once, and agents never apply a change), and gives you four ways in: a web board (installable, phone included), a CLI, an MCP server, and Taskwarrior sync.

These docs cover all of it. Start where you are.

#I want to run a board

  1. Run your own board: nine steps from nothing to a board that starts agents and updates itself. Each step ends in a check.
  2. Concepts: tasks, work IDs, areas, horizons, claims, and how a pull request closes a task. Read it before you add the first task.
  3. The playbook: how to write tasks agents finish, and how to run many of them at once without losing the thread.

#I want the board to run my infrastructure

  1. What Architect is: how a change goes, what stays true, and its words.
  2. Get started with Architect: five steps from a read-only token to your first approved plan on staging.
  3. Architect and the deploy flow: an app’s deploys and its infrastructure on the same staging and production.
  4. Patterns: setups that work, from staging first to an environment per task.

#I want to look something up

Looking forGo to
A commandThe CLI
An HTTP route, or how auth worksThe API
What a view in the browser does, or a keyboard shortcutThe web board
How agents start, what they follow, and the limitsAgents
Features, the Roadmap, chasing a feature, and the pelotonFeatures, chase, and the peloton
Ideas, decisions, and pingsIdeas, decisions, and pings
Saved agent runs on a schedule or an eventRoutines
What Architect is, and how a change to infrastructure goesArchitect
Environments, plans you approve, policy, envelopes, signals, incidents, and costThe Architect section
The GitHub view, packages, pull requests, Review with an agent, merging, Promote and Roll backGitHub
Working the board from Claude Code: /breakaway:claim, next, and hand-overThe Claude Code plugin
Connecting Claude Code or another MCP client to /mcpMCP clients
Taskwarrior 3 syncTaskwarrior
How a release reaches your board, and how to roll one backDeploying and updating
Secrets, rotation, backups, and fixesOperating a board
Redeploying the board and rebuilding environments by hand, without the boardRecover without the board
What runs whereArchitecture
Licence, privacy, and what breakaway doesn’t doFAQ

#What the board promises

These are the claims the docs, the README, and this site all make, and the board has to keep them true.