CLI

The CLI is one binary with no dependencies. It works on one agent per folder: waken deploy creates the agent and writes its id in a .waken file, and the other commands talk to that agent.

Install

macOS, Linux, WSL
curl -fsSL https://waken.sh/install.sh | sh

It installs to ~/.local/bin (set WAKEN_INSTALL_DIR to change it) and verifies the download against its SHA-256 checksum. On Windows without WSL, download https://api.waken.sh/cli/waken-windows-amd64.exe.

Sign in

Terminal
waken login # paste an API key from the dashboard, Developers, API keys
waken logout # remove it from this computer

The key is saved in ~/.config/waken/config.json, readable by you only. In CI, set WAKEN_TOKEN instead: environment variables, or a .env file in the folder, take priority over the saved key.

Commands

CommandWhat it does
waken deployCreate an agent from the current folder and upload its files
waken chat [message]Send a message, or open an interactive conversation
waken statusIs it running, on which harness and model, since when
waken listAll the agents of your account
waken sleep / waken wakePut it to sleep now, or wake it
waken logs [-n 100]What the harness printed
waken exec <command>Run a command on the agent's machine (120 seconds at most)
waken checkpointTake a checkpoint now
waken checkpointsList its checkpoints
waken restore [id]Rewind to a checkpoint (no id: the latest)
waken destroy [--yes]Delete the agent, its files and its checkpoints

Every command takes --agent <id> to target another agent than the one of the current folder.

Deploy options

OptionDefault
--name <name>The folder name
--harness <h>claude-code. Also codex, openclaw, cursor, hermes
--provider <p>Guessed from the key found: anthropic, openai, google, deepseek, moonshot, openrouter
--model <name>The harness default for that provider
--desktopOff. Gives the agent a Linux desktop with a browser (paid plans)
--ram <GB> --disk <GB>2 and 8. Bigger machines are a paid option
--idle <minutes>5. Minutes without activity before it sleeps

The folder is uploaded without .git, node_modules, .venv and .env files. The model key is read from your environment and sent to the agent, never written to its disk.

Terminal
export OPENROUTER_API_KEY=sk-or-...
waken deploy --name research --provider openrouter --model moonshotai/kimi-k2.5 --idle 30
waken exec "ls -la"
waken chat "Summarise what is in this folder"
Next: the HTTP API