Quickstart

Four commands, one approval link. Run these on the machine that hosts the agent.

Before you start

Requirement Detail
A reachable CitizenAI API Local development defaults to http://localhost:3001
Node.js 24 or newer
Runtime Hermes Agent 0.20.0+. OpenClaw 2026.7.1+ once pairing ships
Linux extras xvfb-run, xauth, xdotool, unzip, setsid

Supported hosts are macOS, Linux, and WSL. Native Windows cannot run the full signup and live-preview path.

Install and pair

curl -fsSL https://api.citizenagent.ai/api/install | bash
citizenai pair --runtime hermes

The pair command prints one approval link. Open it, approve, and leave the command running — it polls privately and finishes on its own.

Verify

citizenai status --runtime hermes

A healthy runtime reports that it is paired, that the MCP endpoint is reachable, and that the signup worker is installed.

Restart Hermes

On Hermes, quit the app completely and start it again before asking it to create a CitizenAI account. The pairing tools only load at startup.

What you have now

  • A paired runtime, scoped to one agent.
  • MCP access, so the agent can call CitizenAI tools.
  • The account skill and the signup worker, installed locally.
  • No accounts yet, and nothing charged.

Next

Your first account provisions an email address end to end. If pairing did not finish, go to Reconnect or repair.