从零开始搭建部署 Clawdbot 完整攻略
副标题:新手入门指南 - V1.0版本
📋 目录
简介
Clawdbot 是一个本地优先、自托管的个人AI助手核心,旨在让你在自己的设备上拥有一个完全可控的AI助手,并集成到日常使用的通讯工具中。
🎯 核心功能
- 🏠 本地网关:数据与处理核心运行于你的设备,保障隐私与低延迟。
- 📱 全渠道集成:支持 WhatsApp、Telegram、Slack、Discord 等十余种平台。
- 👥 多智能体路由:为不同联系人、群组分配独立的AI助手角色。
- 🎤 语音交互:支持语音唤醒与持续语音对话(需配置)。
- 🎨 实时画布:提供动态的视觉工作区进行信息展示与交互。
- 🔧 扩展工具:内置及可安装的技能、工具,用于扩展助手能力。
- 📱 多端节点:通过 macOS 菜单栏应用及移动端节点扩展控制。
版本与约定
- 本文适用版本:稳定版(Stable Channel),基于
clawdbot/clawdbot主仓库。 - 命令约定:
$开头的命令表示在终端中执行,#开头的行是注释说明。
系统要求
以下是运行 Clawdbot 网关的基础要求。
| 组件 | 最低要求 | 推荐配置 |
|---|---|---|
| 操作系统 | Windows 10 (WSL2), macOS 11+, Linux (主流发行版) | Windows 11 / macOS 13+ / Ubuntu 22.04 LTS |
| 运行时 | Node.js 20.x | Node.js 22.x (LTS) |
| 内存 | 4 GB RAM | 8 GB RAM 或更多 |
| 磁盘空间 | 2 GB 可用空间 | 5 GB 可用空间 |
| 网络 | 稳定的互联网连接(用于访问AI模型API) | 带宽大于10 Mbps |
⚠️ 各系统额外要求与提醒
- Windows:必须安装并启用 WSL 2(Windows Subsystem for Linux 2)。本教程将在 WSL 2(如 Ubuntu)环境中进行。
- macOS:需要 Xcode Command Line Tools。在终端执行
xcode-select --install即可安装。 - Linux:需要基础开发工具(如
build-essential)。 - 通用提醒:
- 你需要预先准备至少一个 AI 服务的 API 密钥(Anthropic Claude 或 OpenAI ChatGPT)。
- 若在中国大陆地区访问,可能需要配置网络代理才能顺利安装依赖和调用AI API。
Windows 系统安装
由于 Clawdbot 主要基于 Node.js 在 Linux 环境下开发,Windows 用户需通过 WSL 2 获得最佳体验。
步骤 1:安装并配置 WSL 2
- 启用 WSL:以管理员身份打开 PowerShell,执行:
此命令将默认安装 Ubuntu 发行版并启用必要功能。完成后重启电脑。wsl --install - 启动 WSL:从开始菜单启动 “Ubuntu”,完成初始用户账户设置。
步骤 2:在 WSL 中安装 Node.js
- 在 WSL 终端中,使用 NodeSource 仓库安装 Node.js 22 LTS:
curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash - sudo apt-get install -y nodejs - 验证安装:
node --version # 应显示 v22.x.x npm --version # 应显示 10.x.x
步骤 3:安装 Clawdbot
我们使用项目推荐的安装脚本。
- 在 WSL 终端中,执行:
curl -fsSL https://clawbot.dev/install.sh | sh - 脚本会自动下载最新稳定版并安装到
~/.local/share/clawdbot。安装完成后,它会提示你将~/.local/bin加入PATH。 - 配置 PATH:编辑你的 Shell 配置文件(如
~/.bashrc或~/.zshrc),在末尾添加:然后使其生效:export PATH="$HOME/.local/bin:$PATH"source ~/.bashrc - 验证安装:
clawdbot --version
macOS 系统安装
步骤 1:安装 Xcode Command Line Tools 和 Homebrew(推荐)
- 打开终端,安装命令行工具:
xcode-select --install - (可选但推荐)安装 Homebrew 包管理器:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
步骤 2:安装 Node.js
通过 Homebrew 安装 Node.js 22:
brew install node@22
按照提示将 Node.js 加入 PATH。验证安装:node --version。
步骤 3:安装 Clawdbot
与 Windows/WSL 步骤相同。
- 执行安装脚本:
curl -fsSL https://clawbot.dev/install.sh | sh - 将安装路径加入 PATH。对于 macOS,通常也是编辑
~/.zshrc:echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc source ~/.zshrc - 验证安装:
clawdbot --version
Linux 系统安装
本文以 Ubuntu 22.04 为例,其他发行版请调整包管理器命令。
步骤 1:安装 Node.js
curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash -
sudo apt-get update
sudo apt-get install -y nodejs
步骤 2:安装 Clawdbot
过程与 macOS 一致。
- 执行安装脚本:
curl -fsSL https://clawbot.dev/install.sh | sh - 将安装路径加入 PATH(通常是
~/.bashrc):echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc source ~/.bashrc - 验证安装:
clawdbot --version
首次配置向导
安装后,使用交互式向导完成基本配置是最快的方式。
-
启动向导:
clawdbot onboard -
跟随向导步骤:
- 选择模式:首次使用选择
Local(本地模式)。 - 配置 AI 服务:
- 选择
Add a new AI service configuration。 - 选择提供商,如
Anthropic。 - 输入你的 API 密钥。向导会验证密钥有效性。
- 选择默认模型,例如
claude-3-5-sonnet-20241022。
- 选择
- 创建工作区:向导会引导你创建第一个工作区(Workspace),这是 AI 助手的基本运行单元。为其命名,例如
MyAssistant。 - 网关配置:设置网关监听的端口(默认
3000)和主机(默认localhost)。 - 频道集成:选择你想要连接的平台,例如
Telegram。向导会提供详细的步骤引导你获取该平台所需的 Token 或 Webhook 配置信息。你可以先跳过此步,后续再配置。 - 后台服务:向导会询问是否安装并启动系统服务(如 systemd 或 launchd)以保持 Clawdbot 常驻。对于首次体验,可以选择
No,手动启动。
- 选择模式:首次使用选择
-
启动网关并测试: 配置完成后,启动网关服务:
clawdbot start等待几秒后,使用健康检查命令测试:
clawdbot ping如果返回
pong,说明网关运行正常。 -
访问 Web 控制台: 打开浏览器,访问
http://localhost:3000,你可以看到 Clawdbot 的 WebChat 界面和简单的控制面板。在此处可以直接与你的 AI 助手对话。
常用指令大全
clawdbot [命令] [选项]
基础命令
clawdbot start- 启动 Clawdbot 网关服务。clawdbot stop- 停止服务。clawdbot restart- 重启服务。clawdbot status- 查看服务运行状态。clawdbot ping- 检查网关是否健康响应。clawdbot --version- 显示版本信息。clawdbot --help- 显示帮助信息。
配置与管理
clawdbot onboard- 启动交互式配置向导。clawdbot config- 管理配置(查看、编辑、导入、导出)。clawdbot config show # 显示当前配置clawdbot doctor- 诊断当前安装和配置的潜在问题。clawdbot logs- 查看服务日志。clawdbot logs --follow # 实时跟踪日志 clawdbot logs --error # 仅查看错误日志
工作区与智能体
clawdbot workspace- 管理工作区。clawdbot workspace list # 列出所有工作区 clawdbot workspace switch <name> # 切换当前工作区clawdbot agent- 管理智能体(隶属于工作区)。
频道集成
clawdbot channel- 管理消息频道连接。clawdbot channel list # 列出已配置的频道 clawdbot channel test telegram # 测试 Telegram 频道连接
更新
clawdbot update- 检查并更新 Clawdbot 到最新版本。clawdbot channel --self-update- 更新所有已安装的频道适配器。
日常维护
- 定期状态检查:
clawdbot status clawdbot ping - 日志管理:日志文件默认位于
~/.local/share/clawdbot/logs/。定期检查或使用clawdbot logs命令。 - 备份配置与数据:重要数据位于
~/.local/share/clawdbot/目录下,定期备份此目录即可。config/:所有配置文件。data/:运行时数据(如配对信息)。
- 更新流程:
clawdbot stop clawdbot update clawdbot start - 简单监控:可以创建一个简单的脚本
check_clawdbot.sh:并通过 cron 定时运行。#!/bin/bash if ! clawdbot ping > /dev/null 2>&1; then echo "$(date): Clawdbot is down, restarting..." clawdbot restart fi
故障排除
快速诊断流程
- 检查服务状态:
clawdbot status - 查看错误日志:
clawdbot logs --error - 运行诊断:
clawdbot doctor
常见问题
-
症状:
clawdbot命令未找到。- 解决:确认
~/.local/bin已正确加入PATH环境变量,并重新加载 Shell(source ~/.bashrc等)。
- 解决:确认
-
症状:
clawdbot start失败,端口被占用。- 解决:修改网关配置的端口号。先
clawdbot stop,然后编辑~/.local/share/clawdbot/config/gateway.json中的port字段,再clawdbot start。
- 解决:修改网关配置的端口号。先
-
症状:AI 助手不回复,日志显示 API 认证失败。
- 解决:
- 检查 API 密钥是否正确、是否过期。
- 检查网络连接,确认能访问对应 AI 服务商。
- 运行
clawdbot config show检查 AI 服务配置。
- 解决:
-
症状:频道(如 Telegram)消息收不到或发不出。
- 解决:
- 运行
clawdbot channel test <channel_type>测试。 - 检查频道配置的 Token、Webhook URL 是否正确。
- 确保网关服务运行且可从互联网访问(如果你配置了 Webhook)。
- 运行
- 解决:
紧急恢复
若配置混乱导致无法启动,可以尝试重置到初始状态(此操作会清除所有配置和数据):
clawdbot stop
rm -rf ~/.local/share/clawdbot
# 然后重新运行 `clawdbot onboard`
进阶配置
配置基于 JSON 文件,位于 ~/.local/share/clawdbot/config/。以下是一个配置多工作区的示例片段,用于实现消息路由。
假设你想将来自 Telegram 上好友 Alice 的消息和 Slack 上 #general 频道的消息路由到两个不同的智能体。
- 编辑工作区配置文件 (如
workspaces.json):
{
“workspaces”: {
“PersonalBot”: {
“description”: “处理私人聊天”,
“defaultAgent”: “FriendlyHelper”,
“channelRouting”: {
“telegram:alice_username”: “FriendlyHelper” // Telegram 上 Alice 的消息
}
},
“WorkBot”: {
“description”: “处理工作讨论”,
“defaultAgent”: “ProfessionalAssistant”,
“channelRouting”: {
“slack:your-team:#general”: “ProfessionalAssistant” // Slack #general 频道的消息
}
}
},
“agents”: {
“FriendlyHelper”: {
“model”: “claude-3-haiku-20240307”,
“systemPrompt”: “你是一个友好、随和的助手。”
},
“ProfessionalAssistant”: {
“model”: “claude-3-5-sonnet-20241022”,
“systemPrompt”: “你是一个专业、严谨的工作助理。”
}
}
}
- 配置完成后,需要重启网关使配置生效:
clawdbot restart。
常见问题
Q1:Clawdbot 会消耗很多内存吗? A1:网关服务本身内存占用不大(约 200-500 MB)。主要内存消耗取决于你使用的 AI 模型处理长上下文的开销。配置多个工作区或同时处理大量会话会增加内存使用。
Q2:支持哪些 AI 模型? A2:主要官方支持 Anthropic Claude 全系列和 OpenAI GPT 全系列模型。通过社区技能,可能扩展支持其他开源或闭源模型。
Q3:我可以在树莓派上运行吗? A3:可以,但需确认架构支持(通常是 arm64)。性能可能受限于树莓派的内存和计算能力,建议使用轻量级模型(如 Claude Haiku)。
Q4:如何备份我的聊天记录和配置?
A4:定期备份整个 ~/.local/share/clawdbot/ 目录即可。会话历史、配置、配对信息都存储于此。
Q5:如何更新到测试版或开发版? A5:安装脚本默认安装稳定版。如需其他版本,请查阅 GitHub 仓库的开发文档,通常涉及从源码构建。
Q6:我的数据是否会上传到云端? A6:Clawdbot 网关是本地服务。你的对话数据、配置默认存储在本地。只有当你向 AI 服务商(如 Anthropic)发送请求时,提示词和消息内容才会通过其 API 发送。
资源链接与快速参考卡
官方资源
- 项目主页与文档:clawbot.dev
- GitHub 仓库:github.com/clawdbot/cl…
- 社区与讨论:项目 GitHub 的 Issues 和 Discussions 板块。
🚀 快速参考卡(最常用命令)
| 命令 | 功能说明 | 示例 |
|---|---|---|
clawdbot onboard | 交互式配置向导 | clawdbot onboard |
clawdbot start/stop/restart | 启停服务 | clawdbot start |
clawdbot status | 查看状态 | clawdbot status |
clawdbot ping | 健康检查 | clawdbot ping |
clawdbot logs | 查看日志 | clawdbot logs --follow |
clawdbot config show | 查看配置 | clawdbot config show |
clawdbot doctor | 诊断问题 | clawdbot doctor |
clawdbot update | 更新程序 | clawdbot update |
反馈与更新:本指南基于当前稳定版编写。如遇问题,请优先查阅官方文档或 GitHub 社区。祝你使用愉快!