快速开始
目标:尽快从零→第一个可用聊天(使用合理的默认设置)。
最快聊天:打开控制界面(无需配置渠道)。运行 openclaw dashboard 并在浏览器中聊天,或在网关主机上打开 http://127.0.0.1:18789/。 文档:仪表板 和 控制界面。
推荐路径:使用 CLI 入门向导(openclaw onboard)。它会设置:
- 模型/认证(推荐 OAuth)
- 网关设置
- 渠道(WhatsApp/Telegram/Discord/Mattermost(插件)/...)
- 配对默认设置(安全私信)
- 工作区引导 + 技能
- 可选的后台服务
如果您想查看更深入的参考页面,请跳转至:向导、设置、配对、安全。
沙箱注意:agents.defaults.sandbox.mode: "non-main" 使用 session.mainKey(默认 "main"), 因此群组/渠道会话是沙箱化的。如果您希望主代理始终在主机上运行,请设置显式的每个代理覆盖:
{
"routing": {
"agents": {
"main": {
"workspace": "~/.openclaw/workspace",
"sandbox": { "mode": "off" }
}
}
}
}0) 先决条件
- Node
>=22 pnpm(可选;如果从源代码构建则推荐)- 推荐: Brave Search API 密钥用于网络搜索。最简单的方式:
openclaw configure --section web(存储为tools.web.search.apiKey)。 参见 Web 工具。
macOS:如果您计划构建应用程序,请安装 Xcode / CLT。对于仅 CLI + 网关,Node 就足够了。 Windows:使用 WSL2(推荐 Ubuntu)。强烈推荐 WSL2;原生 Windows 未经测试,问题更多,工具兼容性较差。首先安装 WSL2,然后在 WSL 中运行 Linux 步骤。参见 Windows (WSL2)。
1) 安装 CLI(推荐)
curl -fsSL https://openclaw.ai/install.sh | bash安装程序选项(安装方法、非交互式、从 GitHub):安装。
Windows (PowerShell):
iwr -useb https://openclaw.ai/install.ps1 | iex替代方案(全局安装):
npm install -g openclaw@latestpnpm add -g openclaw@latest2) 运行入门向导(并安装服务)
openclaw onboard --install-daemon您需要选择的内容:
- 本地 vs 远程网关
- 认证:OpenAI Code (Codex) 订阅(OAuth)或 API 密钥。对于 Anthropic,我们推荐使用 API 密钥;也支持
claude setup-token。 - 提供商:WhatsApp 二维码登录、Telegram/Discord 机器人令牌、Mattermost 插件令牌等。
- 守护进程:后台安装(launchd/systemd;WSL2 使用 systemd)
- 运行时:Node(推荐;WhatsApp/Telegram 必需)。不推荐 Bun。
- 网关令牌:向导默认生成一个(即使在回环上)并存储在
gateway.auth.token。
向导文档:向导
认证:存储位置(重要)
推荐的 Anthropic 路径: 设置 API 密钥(向导可以存储它供服务使用)。如果您想重用 Claude Code 凭据,也支持
claude setup-token。OAuth 凭据(旧版导入):
~/.openclaw/credentials/oauth.json认证配置文件(OAuth + API 密钥):
~/.openclaw/agents/<agentId>/agent/auth-profiles.json
无头/服务器提示:首先在普通机器上执行 OAuth,然后将 oauth.json 复制到网关主机。
3) 启动网关
如果您在入门过程中安装了服务,网关应该已经在运行:
openclaw gateway status手动运行(前台):
openclaw gateway --port 18789 --verbose仪表板(本地回环):http://127.0.0.1:18789/ 如果配置了令牌,请将其粘贴到控制界面设置中(存储为 connect.params.auth.token)。
⚠️ Bun 警告(WhatsApp + Telegram): Bun 在这些渠道上存在已知问题。如果您使用 WhatsApp 或 Telegram,请使用 Node 运行网关。
3.5) 快速验证(2分钟)
openclaw status
openclaw health
openclaw security audit --deep4) 配对 + 连接您的第一个聊天界面
WhatsApp(二维码登录)
openclaw channels login通过 WhatsApp → 设置 → 已关联的设备进行扫描。
WhatsApp 文档:WhatsApp
Telegram / Discord / 其他
向导可以为您写入令牌/配置。如果您偏好手动配置,从以下开始:
- Telegram:Telegram
- Discord:Discord
- Mattermost(插件):Mattermost
Telegram 私信提示: 您的第一条私信会返回一个配对代码。批准它(参见下一步)否则机器人不会响应。
5) 私信安全(配对审批)
默认策略:未知私信会获得一个短代码,在批准之前消息不会被处理。 如果您的第一条私信没有得到回复,请批准配对:
openclaw pairing list whatsapp
openclaw pairing approve whatsapp <code>配对文档:配对
从源代码(开发)
如果您正在开发 OpenClaw 本身,请从源代码运行:
git clone https://github.com/openclaw/openclaw.git
cd openclaw
pnpm install
pnpm ui:build # auto-installs UI deps on first run
pnpm build
openclaw onboard --install-daemon如果您还没有全局安装,请从仓库通过 pnpm openclaw ... 运行入门步骤。 pnpm build 还打包了 A2UI 资源;如果您只需要运行该步骤,请使用 pnpm canvas:a2ui:bundle。
网关(从此仓库):
node openclaw.mjs gateway --port 18789 --verbose7) 端到端验证
在新终端中,发送一条测试消息:
openclaw message send --target +15555550123 --message "Hello from OpenClaw"如果 openclaw health 显示"未配置认证",请返回向导并设置 OAuth/密钥认证 — 没有它,代理将无法响应。
提示:openclaw status --all 是最佳的可粘贴只读调试报告。 健康探测:openclaw health(或 openclaw status --deep)向运行中的网关请求健康快照。