HomeQuick Start

Quick Start

Get ClawdBot running in 5 minutes

Requirements

Before you start, make sure you have:

  • Node.js 22 or higher
  • Operating System: macOS, Windows (WSL2), or Linux
  • AI Model Access: Anthropic Claude or OpenAI subscription
  • Messaging App: WhatsApp, Telegram, or Discord account

Don't have Node.js? The one-liner installer will install it for you automatically.

Installation

Choose your preferred installation method:

Option 1: One-liner (Recommended)

The easiest way - installs everything including Node.js:

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

Option 2: npm Global Install

If you already have Node.js 22+:

npm install -g clawdbot@latest
clawdbot onboard

Option 3: pnpm

pnpm add -g clawdbot@latest
clawdbot onboard

Option 4: From Source (Hackable)

For developers who want to customize:

git clone https://github.com/clawdbot/clawdbot.git
cd clawdbot
pnpm install
pnpm build
clawdbot onboard

Onboarding Wizard

After installation, run the onboarding wizard:

clawdbot onboard --install-daemon

The wizard will guide you through:

  • Setting up your AI model (Claude or OpenAI)
  • Configuring the Gateway service
  • Installing the background daemon (launchd/systemd)
  • Basic preferences and settings

Install Daemon

The --install-daemon flag sets up ClawdBot to run automatically in the background. It will start on boot and stay running.

Pair WhatsApp

Connect your WhatsApp account to control ClawdBot:

clawdbot channels login

This will display a QR code. Scan it with your WhatsApp:

  1. Open WhatsApp on your phone
  2. Go to Settings → Linked Devices
  3. Tap "Link a Device"
  4. Scan the QR code shown in terminal

Note: For Telegram, Discord, or other platforms, see the Channels documentation.

Send Your First Message

Once paired, send a message to yourself on WhatsApp:

Hello ClawdBot!

ClawdBot will respond! Try these commands:

  • What can you do? - See capabilities
  • What's the weather today? - Get information
  • Remind me to call Mom at 5pm - Set reminders
  • Check my calendar for tomorrow - Calendar access
  • /help - Show available commands

Slash Commands

ClawdBot supports slash commands for quick actions:

  • /activation always - Always respond to messages
  • /activation mention - Only respond when @mentioned
  • /skills - List available skills
  • /status - Check ClawdBot status

Next Steps

Congratulations! ClawdBot is now running. Here's what to explore next:

Platform-Specific Guides

Configure More Channels

Advanced Configuration

Useful Commands

# Start the gateway manually
clawdbot gateway --port 18789

# Check status
clawdbot doctor

# Send a test message
clawdbot message send --target +1234567890 --message "Hello"

# View logs
clawdbot logs