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, and gives you three ways in: a web board (installable, phone included), a CLI, and Taskwarrior sync.
These docs cover all of it. Start where you are.
#I want to run a board
- Run your own board: eight steps from nothing to a board that starts agents and updates itself. Each step ends in a check.
- Concepts: tasks, work IDs, areas, horizons, claims, and how a pull request closes a task. Read it before you add the first task.
- The playbook: how to write tasks agents finish, and how to run many of them at once without losing the thread.
#I want to look something up
| Looking for | Go to |
|---|---|
| A command | The CLI |
| An HTTP route, or how auth works | The API |
| What a view in the browser does, or a keyboard shortcut | The web board |
| How agents start, what they follow, and the limits | Agents |
| Ideas, decisions, and pings | Ideas, decisions, and pings |
| Saved agent runs on a schedule or an event | Routines |
| Pull requests, merging, Promote and Roll back | GitHub |
| Taskwarrior 3 sync | Taskwarrior |
| How a release reaches your board, and how to roll one back | Deploying and updating |
| Secrets, rotation, backups, and fixes | Operating a board |
| What runs where | Architecture |
| Licence, privacy, and what breakaway doesn’t do | FAQ |
#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.
- One claim per task. Claiming is atomic, so two agents never work on the same task.
- Pull requests close tasks. A pull request that says
Closes BRK-12.puts the task in review, and the task is done when it merges. - Agents start from the board. Start Claude Code cloud agents on tasks, cap how many run, and watch their output live on the task. Local Claude Code sessions work through the CLI.
- Agents ping you when they need you. The rest waits on the board.
- One board, several repositories, each with its own areas, prompt, and agents.
- Three ways in, one set of data: the web board, a CLI, and Taskwarrior sync.
- It runs on Cloudflare: Workers and a Durable Object.
- Free, and the source is public. The licence is FSL-1.1-Apache-2.0.