OpenClaw in 10 Minutes: Complete Setup Guide
OpenClaw in 10 Minutes ⚡
Section titled “OpenClaw in 10 Minutes ⚡”OpenClaw is a self-hosted AI assistant platform that connects to your messaging apps. One server, 20+ channels, full control over your data. By the end of this guide, you’ll have a working AI assistant you can message from your phone.
Prerequisites
Section titled “Prerequisites”| Requirement | Details |
|---|---|
| OS | macOS, Linux, or Windows (WSL2 strongly recommended) |
| Node.js | v22 or newer (node --version to check) |
| AI Provider Key | Anthropic, OpenAI, Google, or any OpenAI-compatible provider |
| 10 minutes | That’s it |
Step 1: Install OpenClaw
Section titled “Step 1: Install OpenClaw”import { Tabs, TabItem } from ‘@astrojs/starlight/components’;
Verify the install
Section titled “Verify the install”openclaw --versionStep 2: Run the Onboarding Wizard
Section titled “Step 2: Run the Onboarding Wizard”openclaw onboard --install-daemonThe wizard walks you through everything:
- Auth — Choose your AI provider and paste your API key (or use OAuth for Anthropic). Supports OpenAI, Anthropic, Google, and any OpenAI-compatible endpoint.
- Workspace — Sets up
~/.openclaw/workspace/with starter files (SOUL.md,AGENTS.md,USER.md). - Gateway — Configures the local server (default port
18789). - Channels — Connect WhatsApp, Telegram, Discord, Signal, Slack, and more.
- Daemon — Installs a LaunchAgent (macOS) or systemd user unit (Linux) so OpenClaw starts automatically.
- Skills — Installs recommended skills and optional dependencies.
Step 3: Verify the Gateway
Section titled “Step 3: Verify the Gateway”If you used --install-daemon, the Gateway should already be running:
openclaw gateway statusYou should see the Gateway running on port 18789. You can also test it immediately without any channel setup:
openclaw dashboardThis opens the Control UI in your browser at http://127.0.0.1:18789/ — you can chat with your agent right there.
Step 4: Connect a Channel
Section titled “Step 4: Connect a Channel”Telegram (easiest to set up)
Section titled “Telegram (easiest to set up)”- Open @BotFather on Telegram
- Send
/newbotand follow the prompts - Copy the bot token (looks like
123456:ABC-DEF...) - Paste it when the wizard asks — or add it later:
Terminal window openclaw configure --section channels - Message your bot on Telegram
- The wizard (or
openclaw channels login --channel whatsapp) shows a QR code - Open WhatsApp on your phone → Settings → Linked Devices → Link a Device
- Scan the QR code
- Done — your assistant is live on WhatsApp
Discord
Section titled “Discord”- Go to discord.com/developers → New Application
- Go to Bot → Reset Token → copy it
- Enable Message Content Intent under Privileged Gateway Intents (required!)
- Go to OAuth2 → URL Generator → select
botscope → select permissions → invite to your server - Paste the token in the wizard
Other channels
Section titled “Other channels”OpenClaw supports 20+ channels: Signal, Slack, Google Chat, iMessage, Matrix, Mattermost, IRC, Line, Nostr, and more. Run openclaw configure --section channels to add any of them.
Step 5: Send Your First Message
Section titled “Step 5: Send Your First Message”Open your messaging app and send anything to your bot:
“Hey, what can you do?”
Your AI assistant will respond. Out of the box, it can:
- 🔍 Search the web (set up a Brave Search API key via
openclaw configure --section webfor best results) - 📁 Read and write files on your machine
- 🖥️ Run shell commands
- ⏰ Set reminders and cron jobs
- 🌐 Control a web browser
- 📷 Access cameras (with paired mobile nodes)
- 🎤 Voice conversations (macOS/iOS/Android)
- 📊 Manage sessions and spawn sub-agents
Step 6: Make It Yours
Section titled “Step 6: Make It Yours”The real power is in the workspace files at ~/.openclaw/workspace/. These aren’t just config — they’re your agent’s brain.
SOUL.md — Personality & Boundaries
Section titled “SOUL.md — Personality & Boundaries”This defines who your agent is. Tone, values, what it will and won’t do.
# Who You Are
Be genuinely helpful, not performatively helpful.Skip the "Great question!" — just help.
Have opinions. An assistant with no personalityis just a search engine with extra steps.
Be resourceful before asking. Try to figure it out.Read the file. Search for it. Then ask if you're stuck.👉 Full guide: Crafting the Perfect SOUL.md
AGENTS.md — Operating Instructions
Section titled “AGENTS.md — Operating Instructions”How your agent handles tasks, memory, tools, and communication. This is the playbook.
USER.md — Who You Are
Section titled “USER.md — Who You Are”Tell your agent about yourself so it can be contextually helpful:
# About You- **Name:** Alex- **Timezone:** America/New_York- **Notes:** Runs a startup. Time is scarce. Short messages = full expectations.IDENTITY.md — Name & Avatar
Section titled “IDENTITY.md — Name & Avatar”Your agent’s name, emoji, and vibe. Created during the bootstrap ritual.
Troubleshooting
Section titled “Troubleshooting”openclaw doctor
Section titled “openclaw doctor”Run the built-in diagnostic tool:
openclaw doctorThis checks your install, config, credentials, and common issues.
Common issues
Section titled “Common issues”| Problem | Fix |
|---|---|
openclaw: command not found | Add npm’s bin directory to PATH (see Step 1) |
| Gateway won’t start | Check if port 18789 is in use: lsof -i :18789 |
| WhatsApp QR code expired | Re-run openclaw channels login --channel whatsapp |
spawn git ENOENT on Windows | Install Git for Windows, reopen PowerShell |
| sharp/libvips build errors | Set SHARP_IGNORE_GLOBAL_LIBVIPS=1 (the installer does this by default) |
| Extra workspace directories | Keep one active workspace. openclaw doctor warns about extras. Remove old ones with trash ~/openclaw |
| EACCES on npm install (Linux) | Installer can fix this. Or manually: npm config set prefix ~/.npm-global |
Environment variables
Section titled “Environment variables”If you need custom paths:
OPENCLAW_HOME— home directory for internal path resolutionOPENCLAW_STATE_DIR— override state directoryOPENCLAW_CONFIG_PATH— override config file path
What’s Next?
Section titled “What’s Next?”- Crafting the Perfect SOUL.md — Give your agent real personality
- 5 Automations That Save Hours — Cron jobs, heartbeats, email monitoring
- Multi-Agent Routing — One bot per channel
- Starter Kits — Pre-built configurations for specific workflows
Having issues? Run openclaw doctor to diagnose common problems, or check the OpenClaw docs.