快速开始
目标:从零到第一次成功对话(使用合理的默认配置),尽可能快速地完成。
推荐路径:使用 CLI 引导向导 (clawdbot onboard)。它会设置:
- 模型/认证(推荐 OAuth)
- 网关设置
- 渠道(WhatsApp/Telegram/Discord/Mattermost 插件/...)
- 配对默认设置(安全私信)
- 工作区引导 + 技能
- 可选的后台服务
系统要求
- Node.js >= 22 (推荐使用 LTS 版本)
- pnpm(可选;如果从源码构建则推荐使用)
- 操作系统:
- macOS (Intel 或 Apple Silicon)
- Linux (Debian, Ubuntu, CentOS 等)
- Windows (需要 WSL2,强烈推荐)
- 推荐: Brave Search API 密钥用于网页搜索
macOS:如果您计划构建应用程序,请安装 Xcode / CLT。仅使用 CLI + 网关的话,Node 就足够了。
安装方法
方法一:一键安装脚本 (推荐)
curl -fsSL https://clawd.bot/install.sh | bashWindows (PowerShell):
iwr -useb https://clawd.bot/install.ps1 | iex方法二:npm/pnpm 全局安装
# 使用 npm
npm install -g clawdbot@latest
# 或使用 pnpm (推荐)
pnpm add -g clawdbot@latest验证安装
clawdbot --version运行引导向导
clawdbot onboard --install-daemon向导将引导你完成:
- 本地 vs 远程 网关选择
- 认证配置:
- OpenAI Code (Codex) 订阅(OAuth)
- Anthropic API 密钥(推荐)
- 也支持
claude setup-token
- 渠道配置:WhatsApp QR 登录、Telegram/Discord 机器人令牌等
- 守护进程:后台安装(launchd/systemd)
- 运行时:Node(推荐;WhatsApp/Telegram 必需)。不推荐 Bun。
- 网关令牌:向导默认生成一个
认证存储位置
- OAuth 凭据:
~/.clawdbot/credentials/oauth.json - 认证配置文件:
~/.clawdbot/agents/<agentId>/agent/auth-profiles.json
无头/服务器提示:先在普通机器上进行 OAuth,然后将 oauth.json 复制到网关主机。
启动网关
如果您在引导过程中安装了服务,网关应该已经在运行:
clawdbot gateway status手动运行(前台):
clawdbot gateway --port 18789 --verbose仪表板(本地):http://127.0.0.1:18789/
Bun 警告: Bun 与 WhatsApp/Telegram 存在已知问题。请使用 Node 运行网关。
快速验证
clawdbot status
clawdbot health连接聊天平台
WhatsApp(QR 登录)
clawdbot channels login通过 WhatsApp → 设置 → 链接设备 扫描。
Telegram / Discord / 其他
向导可以为您写入令牌/配置:
Telegram 私信提示: 您的第一条私信会返回一个配对码。批准它否则机器人不会响应。
私信安全(配对批准)
默认:未知私信会收到一个短代码,消息不会被处理直到获得批准。
clawdbot pairing list whatsapp
clawdbot pairing approve whatsapp <code>详见 配对
从源码构建
git clone https://github.com/clawdbot/clawdbot.git
cd clawdbot
pnpm install
pnpm ui:build
pnpm build
clawdbot onboard --install-daemon端到端验证
clawdbot message send --target +15555550123 --message "Hello from Clawdbot"提示:clawdbot status --all 是最佳的可粘贴、只读调试报告。