HomeDocsGetting Started

Getting Started

Go from zero → first working chat (with sane defaults) as quickly as possible

Recommended path: use the CLI onboarding wizard (clawdbot onboard). It sets up:

  • model/auth (OAuth recommended)
  • gateway settings
  • channels (WhatsApp/Telegram/Discord/Mattermost/…)
  • pairing defaults (secure DMs)
  • workspace bootstrap + skills
  • optional background service

0) Prereqs

  • Node ≥22
  • pnpm (optional; recommended if you build from source)
  • Recommended: Brave Search API key for web search. Easiest path: clawdbot configure --section web
  • macOS: if you plan to build the apps, install Xcode / CLT. For the CLI + gateway only, Node is enough.
  • Windows: use WSL2 (Ubuntu recommended). WSL2 is strongly recommended; native Windows is untested.

1) Install the CLI (recommended)

curl -fsSL https://clawd.bot/install.sh | bash

Windows (PowerShell):

iwr -useb https://clawd.bot/install.ps1 | iex

Alternative (global install):

npm install -g clawdbot@latest
pnpm add -g clawdbot@latest

2) Run the onboarding wizard (and install the service)

clawdbot onboard --install-daemon

What you'll choose:

  • Local vs Remote gateway
  • Auth: OpenAI Code (Codex) subscription (OAuth) or API keys. For Anthropic we recommend an API key.
  • Providers: WhatsApp QR login, Telegram/Discord bot tokens, Mattermost plugin tokens, etc.
  • Daemon: background install (launchd/systemd; WSL2 uses systemd)
  • Runtime: Node (recommended; required for WhatsApp/Telegram). Bun is not recommended.
  • Gateway token: the wizard generates one by default and stores it in gateway.auth.token.

Auth: where it lives (important)

  • Recommended Anthropic path: set an API key (wizard can store it for service use).
  • OAuth credentials (legacy import): ~/.clawdbot/credentials/oauth.json
  • Auth profiles (OAuth + API keys): ~/.clawdbot/agents/<agentId>/agent/auth-profiles.json
  • Headless/server tip: do OAuth on a normal machine first, then copy oauth.json to the gateway host.

3) Start the Gateway

If you installed the service during onboarding, the Gateway should already be running:

clawdbot gateway status

Manual run (foreground):

clawdbot gateway --port 18789 --verbose

Dashboard (local loopback): http://127.0.0.1:18789/

⚠️ Bun warning (WhatsApp + Telegram)

Bun has known issues with these channels. If you use WhatsApp or Telegram, run the Gateway with Node.

3.5) Quick verify (2 min)

clawdbot status
clawdbot health

4) Pair + connect your first chat surface

WhatsApp (QR login)

clawdbot channels login

Scan via WhatsApp → Settings → Linked Devices.

Telegram / Discord / others

The wizard can write tokens/config for you. If you prefer manual config, see:

Telegram DM tip: your first DM returns a pairing code. Approve it (see next step) or the bot won't respond.

5) DM safety (pairing approvals)

Default posture: unknown DMs get a short code and messages are not processed until approved.

If your first DM gets no reply, approve the pairing:

clawdbot pairing list whatsapp
clawdbot pairing approve whatsapp <code>

From source (development)

If you're hacking on Clawdbot itself, run from source:

git clone https://github.com/clawdbot/clawdbot.git
cd clawdbot
pnpm install
pnpm ui:build  # auto-installs UI deps on first run
pnpm build

Next steps (optional, but great)