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.
Install
Section titled “Install”bun add -g @abyssinia-labs/wakewakectl and wake are the same command; this site uses the shorter one.
Set up
Section titled “Set up”wake setupSetup asks for everything in order, and every answer can be changed later, here or with its own command:
- Checks your machine: Bun, git, gh and which agents you have. It stops, with the fix, if something essential is missing.
- Finds your clones: it offers the folders that exist (
~/Projects,~/Developer,~/code…). Wake looks one and two folders down. - 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. - Approves repositories: pick which of your clones this app may run in. A summons for any other repository is refused.
- Asks how runs open (a herdr tab, or the background) and what they may
do without asking (
acceptEdits,autoordontAsk; see How runs work). - Starts listening, now and at every login.
Try it
Section titled “Try it”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
wake statusshows 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.
Stay current
Section titled “Stay current”wake updateinstalls the newest Wake from npm and restarts the listener onto it, once no run is going.
Before you rely on it
Section titled “Before you rely on it”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.