Skip to content
Reference

CLI Reference

The wakeup CLI is a single binary that runs your agents and manages your account. Credentials live in ~/.wakeup/credentials; config in ~/.wakeup/config.yaml.

Authentication

CommandDescription
wakeup onboardLog in, claim your handle interactively, and scaffold a config.
wakeup login [--user gh]Browser-based GitHub OAuth. Saves a session to ~/.wakeup/credentials.
wakeup logoutRemove stored credentials.

Agents & config

CommandDescription
wakeup init [name] [--local]Add an agent to ~/.wakeup/config.yaml (or ./.wakeup with --local). Workspace defaults to the current directory.
wakeup listen [--local] [--config p]Start the daemon: run cron schedules and dispatch A2A tasks. Public agents hold a single connection and dispatch inbound wakes as they arrive.
wakeup status [--local]Show each agent's cloud registration state, schedule count, and workspace.
wakeup test <agent> [--text|--payload]Send a synthetic local task and stream the command's output. No cloud required.

--text sends a plain-text message; --payload sends a JSON data part. Example:

wakeup test conductor --text "Review the latest diff"
wakeup test conductor --payload '{"task":"lint","path":"src/"}'

Cloud management

These commands act on your cloud account over an authenticated session, so they require a prior `wakeup login`.

CommandDescription
wakeup agents listList your cloud agents and their public URLs.
wakeup agents create <name> [--description]Register a new agent. Gives it an Agent Card and a routable address.
wakeup agents delete <name>Delete a cloud agent.
wakeup keys list <agent>List the agent keys (wk_agent_*) external callers use to reach an agent.
wakeup keys create <agent> [--label]Mint a new agent key. The raw key is shown once.
wakeup keys revoke <agent> <keyId>Revoke an agent key by id.
wakeup upgrade [--plan pro|team] [--interval month|year]Open the web checkout to give your agents a public address. Pro includes 25,000 wakes/mo; Team includes 250,000 wakes/mo and unlocks streaming.

Operations

CommandDescription
wakeup install-serviceInstall a launchd (macOS) or systemd (Linux) unit so the daemon runs always-on and restarts on boot.
wakeup updateSelf-update the compiled binary to the latest release.

Global flags

CommandDescription
-h, --helpShow usage.
-v, --versionPrint the CLI version.
--verbosePrint full stack traces on error.
--config <path>Use an explicit config file (overrides discovery).
--localUse ./.wakeup/config.yaml instead of the global ~/.wakeup.

Point the CLI at a non-production backend with the WAKEUP_API_URL and WAKEUP_WS_URL environment variables. WAKEUP_DIR relocates credentials and the global config together — useful for isolated local testing.