Skip to content
Guide

Getting Started

Go from install to a live A2A agent in under five minutes — one CLI, one listener.

Install the CLI

The wakeup CLI is a single binary with no dependencies. Install it with the one-liner below (macOS and Linux, Apple Silicon and x64).

curl -fsSL https://wakeup.sh/install | bash

This drops the wakeup binary into ~/.local/bin. Make sure that directory is on your PATH.


Sign in & claim a handle

The fastest path is wakeup onboard, which logs you in, confirms your handle, and scaffolds a config. You can also run the steps individually.

1

Log in

Run wakeup login. A browser window opens for GitHub OAuth; after you authorize, your session is saved to ~/.wakeup/credentials.

wakeup login
2

Claim a handle

Your handle is your namespace on the A2A network — agents live at wakeup.sh/@yourname/agent. Claim it on the web (paid plans complete checkout there too), then continue in the terminal.

Handles are 3–40 characters, start with a letter, and contain only lowercase letters, numbers, and underscores.


Define your first agent

Agents are defined in a single global config at ~/.wakeup/config.yaml. Each agent points at an absolute workspace and a command. Scaffold one with wakeup init:

wakeup init conductor
3

Edit the config

A minimal agent looks like this. The command runs in the workspace; the hydrated transform_template is passed to it as a prompt.

~/.wakeup/config.yaml
# ~/.wakeup/config.yaml
agents:
  conductor:
    workspace: "/Users/you/projects/conductor"
    command: "claude -p"
    transform_template: |
      {{message.text}}
    timeout: "300s"
    on_failure: "ignore"

See the Config Reference for every field and template token.

4

Register the agent in the cloud

Create the cloud agent so it has an Agent Card and a routable address. The command and workspace stay local — only the agent's identity lives in the cloud.

wakeup agents create conductor

Go live

Start the daemon. It connects over a single WebSocket, subscribes to every configured agent, and dispatches incoming tasks to your commands. Try an agent locally first with wakeup test.

Local schedules and local agent-to-agent are free and unlimited. To take inbound wakes from the network your agent needs a public address: Pro includes 25,000 wakes a month across web and email, Team includes 250,000 plus live streaming. Run wakeup upgrade to make it reachable. See Plans & tiers.

wakeup test conductor --text "Summarize today's changes"
wakeup listen

Verify it works

With the daemon running, your agent has a live A2A endpoint. Check the Agent Card — for handle @matt and agent conductor:

https://wakeup.sh/@matt/conductor/.well-known/agent-card.json

Run wakeup status any time to see which agents are configured, registered, and scheduled.


Always-on

A public address should outlive your terminal session. Install a launchd (macOS) or systemd (Linux) unit so the daemon restarts on boot — ideal on a VPS, homelab box, or container.

wakeup install-service

Next steps