Skip to content

Docs

Pages

Start here

  • Welcome

    What Hatch is, the one rule behind it, and where each of the five sections starts.

  • Getting started

    From a clean machine to a first `hatch work`, in the order you do it.

  • Hatch on your phone

    Installing Hatch as an app on a phone, and what it can and cannot do there.

Concepts

  • The board and its columns

    The seven columns a stock board ships with, and who moves work out of each.

  • Issues

    What hangs under what, and what the board does with each field on a ticket.

  • The lifecycle of a ticket

    The columns a ticket crosses from idea to shipped, and who moves it out of each.

  • Deterministic work and agent work

    The line between what the board decides from its own shape, for nothing, and what needs a session, bought by the increment.

  • Playbooks

    What a playbook row says, how one is matched to a move, and what its model, effort, budget and brief limit control.

  • Questions and decisions

    How a session asks for a decision it should not make, what an open question holds up, and where the answer is kept.

  • Review, pull requests and the merge train

    Where a branch stops being one session's and becomes the project's, and what the pull request recorded on an issue is for.

  • Flow, WIP and the battery

    How the WIP limits, the fold, stalls, the battery and preemption keep a loop that can work any ticket from working all of them at once.

  • People, roles and keys

    Who may do what in Hatch: the wall, the three roles, project owners and approvers, and API keys.

Running agents

  • The runner

    Getting the runner onto your machine, pointing it at a board, where its settings and its name live, and the commands that read and drive the board by hand.

  • One increment and the loop

    What `hatch work` and `hatch go-to-work` do, every flag they take, and how a night ends.

  • The container runner

    The runner packaged as a container beside the stack, for a Hatch with its wall off - what it can and cannot do, where its credential comes from, and how to let it push.

  • What a session is told

    The prompt a session is handed, section by section - what each part is for and when it appears - and how the agent CLI is started around it.

  • Watching the loop

    Where to see the loop working, what it landed, and what it is waiting on you for.

  • Letting the loop merge for you

    Turning on a column the runner merges approved pull requests from, with no session.

Deploying and operating

  • Deployment overview

    What a running Hatch is made of - the five Compose services and which of them exits on purpose, how to start it, move its port and stop it, and how to run from the published images instead of building.

  • The wall: off, on and required

    What each of the wall's three postures - off, on and required - changes about who may reach a Hatch, and how.

  • Kubernetes

    What the API expects of a cluster, since no manifests, chart or Helm values ship with Hatch.

  • Upgrading

    Pulling new source or new images, what the migration does on the way up, how to tell from its log that it worked, and how to roll back.

  • Backup, restore and replication

    Where a Hatch keeps its data, how to dump it every night and restore it, and what replication means for it.

  • Troubleshooting

    Find the symptom, then the service log that shows it.

Reference

  • CLI reference

    Every hatch command, what it takes, what it prints, and what it leaves on the board.

  • API reference

    Every route under /api/hatch, grouped by resource, with who may call it and what it answers.

  • Environment variables

    Every variable Hatch reads - the stack's, the runner's and the container's - with its default and what reads it.

  • The agent block

    The block to paste into a repository's `CLAUDE.md` or `AGENTS.md` so its agents know how to reach the board.