Guides
Operating guides.
A guide takes you from one state to another: from a clean machine to the factory running, from an open task to a pull request. This section is being written, and whatever hasn't become a guide yet stays in the repository, linked below instead of summarized here.
Section under construction. Only the quickstart is written so far. The other topics already exist as documents in docs/ in the repository and are the source of truth until they become guides. No link here points to a page that does not exist.
Written
Still in the repository
Each one of these is a document kept next to the code. As each becomes a guide, this list shrinks and the one above grows.
| Subject | Document | What it covers |
|---|---|---|
| Going to production | GO-LIVE.md | A checklist for running it for real, locally or on an external instance. |
| Two hosts and TLS | MULTI-HOST-GATE-SETUP.md | Control plane on one host, worker on another, with credentials and lease reclaim. |
| Vocabulary of the process | DOMAIN.md | Domains, business flows and the delivery glossary. |
| HTTP API | API.md | REST routes, the SSE stream and response formats. |
| Task intake | API-INTAKE.md | How a task enters the factory from outside the cockpit. |
| Modules from the inside | docs/modules/ | Auth, routes, durable execution, worktrees, control plane, triggers. |
If you just want to see it running
The shortest path is the quickstart: Node 22+, an authenticated agent CLI, four commands and the cockpit open at localhost:4173.
Next Quickstart →