Skip to content

Getting started

Wake runs on macOS. You need Bun 1.3.3 or later, git, the GitHub CLI (gh, signed in) for pull requests, and at least one agent: Claude Code (claude), Codex (codex) or Cursor’s CLI (cursor-agent), connected to your app’s MCP server.

Terminal window
bun add -g @abyssinia-labs/wake

wakectl and wake are the same command; this site uses the shorter one.

Terminal window
wake setup

Setup asks for everything in order, and every answer can be changed later, here or with its own command:

  1. Checks your machine: Bun, git, gh and which agents you have. It stops, with the fix, if something essential is missing.
  2. Finds your clones: it offers the folders that exist (~/Projects, ~/Developer, ~/code…). Wake looks one and two folders down.
  3. Pairs your agent. In your agent, with the app’s MCP server connected, ask: “Pair Wake with this machine.” It answers with a command like wakectl pair app.example.com K7QD-2M9X. Paste it into setup.
  4. Approves repositories: pick which of your clones this app may run in. A summons for any other repository is refused.
  5. Asks how runs open (a herdr tab, or the background) and what they may do without asking (acceptEdits, auto or dontAsk; see How runs work).
  6. Starts listening, now and at every login.

Assign your agent a ticket, or mention it in a comment. Within seconds the app says your agent is on it, under the run’s name (amber-heron), and

Terminal window
wake status

shows the run on this machine. Follow it live with wake logs -f, or watch its herdr tab. Afterwards, wake open amber-heron puts you back in its session, in its folder.

Terminal window
wake update

installs the newest Wake from npm and restarts the listener onto it, once no run is going.

Turn on branch protection on each repository’s default branch: a ruleset that requires a pull request and lets nobody bypass it, admins included. Wake’s own fences keep an honest agent on track; GitHub is the fence that holds. See Security.

If anything looks wrong, wake doctor lists what’s missing, each with its fix.