跳到主要内容

入门

目标:尽快从第一个正常工作的聊天(使用合理默认值)。

最快聊天:打开控制界面(无需设置频道)。运行 moltbot dashboard 并在浏览器中聊天,或在网关主机上打开 http://127.0.0.1:18789/。 文档:仪表板控制界面

推荐路径:使用CLI 入职向导moltbot onboard)。它设置:

  • 模型/认证(推荐 OAuth)
  • 网关设置
  • 频道(WhatsApp/Telegram/Discord/Mattermost(插件)/...)
  • 配对默认值(安全私信)
  • 工作区引导 + 技能
  • 可选后台服务

如果您想要更深入的参考页面,请跳转到:向导设置配对安全性

沙盒注意:agents.defaults.sandbox.mode: "non-main" 使用 session.mainKey(默认为 "main"), 因此群组/频道会话被沙盒化。如果您希望主代理始终 在主机上运行,请设置明确的每代理覆盖:

{
"routing": {
"agents": {
"main": {
"workspace": "~/clawd",
"sandbox": { "mode": "off" }
}
}
}
}

0) 先决条件

  • Node >=22
  • pnpm(可选;如果您从源码构建则推荐)
  • 推荐: 用于网络搜索的 Brave Search API 密钥。最简单的路径: moltbot configure --section web(存储 tools.web.search.apiKey)。 参见 网络工具

macOS:如果您计划构建应用程序,请安装 Xcode / CLT。仅用于 CLI + 网关,Node 就足够了。 Windows:使用 WSL2(推荐 Ubuntu)。强烈推荐 WSL2;原生 Windows 未经测试,问题更多,工具兼容性更差。首先安装 WSL2,然后在 WSL 内运行 Linux 步骤。参见 Windows (WSL2)

1) 安装 CLI(推荐)

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

安装程序选项(安装方法、非交互式、来自 GitHub):安装

Windows(PowerShell):

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

替代方案(全局安装):

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

2) 运行入职向导(并安装服务)

moltbot onboard --install-daemon

您将选择:

  • 本地 vs 远程 网关
  • 认证:OpenAI Code(Codex)订阅(OAuth)或 API 密钥。对于 Anthropic,我们推荐 API 密钥;也支持 claude setup-token
  • 提供商:WhatsApp QR 登录、Telegram/Discord 机器人令牌、Mattermost 插件令牌等。
  • 守护进程:后台安装(launchd/systemd;WSL2 使用 systemd)
    • 运行时:Node(推荐;WhatsApp/Telegram 必需)。不推荐 Bun。
  • 网关令牌:向导默认生成一个(即使在回环上)并存储在 gateway.auth.token 中。

向导文档:向导

认证:它在哪里(重要)

  • 推荐的 Anthropic 路径: 设置一个 API 密钥(向导可以为其服务使用存储它)。如果您想重用 Claude Code 凭据,也支持 claude setup-token

  • OAuth 凭据(旧版导入):~/.clawdbot/credentials/oauth.json

  • 认证配置文件(OAuth + API 密钥):~/.clawdbot/agents/<agentId>/agent/auth-profiles.json

无头/服务器提示:首先在普通机器上执行 OAuth,然后将 oauth.json 复制到网关主机。

3) 启动网关

如果您在入职期间安装了服务,网关应该已经在运行:

moltbot gateway status

手动运行(前台):

moltbot gateway --port 18789 --verbose

仪表板(本地回环):http://127.0.0.1:18789/ 如果配置了令牌,请将其粘贴到控制界面设置中(存储为 connect.params.auth.token)。

⚠️ Bun 警告(WhatsApp + Telegram): Bun 在这些 频道上有已知问题。如果您使用 WhatsApp 或 Telegram,请使用 Node 运行网关。

3.5) 快速验证(2 分钟)

moltbot status
moltbot health
moltbot security audit --deep

4) 配对 + 连接您的第一个聊天界面

WhatsApp(QR 登录)

moltbot channels login

通过 WhatsApp → 设置 → 已连接的设备扫描。

WhatsApp 文档:WhatsApp

Telegram / Discord / 其他

向导可以为您编写令牌/配置。如果您更喜欢手动配置,请从以下开始:

Telegram 私信提示: 您的第一条私信返回一个配对代码。批准它(参见下一步)或机器人不会响应。

5) 私信安全(配对批准)

默认姿态:未知私信获得一个短代码,消息在批准前不会被处理。 如果您的第一条私信没有回复,请批准配对:

moltbot pairing list whatsapp
moltbot pairing approve whatsapp <code>

配对文档:配对

从源码(开发)

如果您正在修改 Moltbot 本身,请从源码运行:

git clone https://github.com/moltbot/moltbot.git
cd moltbot
pnpm install
pnpm ui:build # 首次运行时自动安装 UI 依赖项
pnpm build
moltbot onboard --install-daemon

如果您还没有全局安装,请从仓库通过 pnpm moltbot ... 运行入职步骤。 pnpm build 也会打包 A2UI 资产;如果您只需要运行那一步,请使用 pnpm canvas:a2ui:bundle

网关(来自此仓库):

node moltbot.mjs gateway --port 18789 --verbose

7) 端到端验证

在新终端中,发送测试消息:

moltbot message send --target +15555550123 --message "Hello from Moltbot"

如果 moltbot health 显示"未配置认证",请回到向导并设置 OAuth/密钥认证 — 代理将无法响应。

提示:moltbot status --all 是最佳的可粘贴、只读调试报告。 健康探针:moltbot health(或 moltbot status --deep)向运行中的网关请求健康快照。

下一步(可选,但很好)