快速开始

目标：从零到第一次可用的聊天（使用合理的默认配置），尽可能快速。

最快的聊天方式：打开控制界面（Control UI）（无需频道设置）。运行 openclaw dashboard 在浏览器中聊天，或在网关（Gateway）主机上打开 http://127.0.0.1:18789/。 文档：Dashboard 和 Control UI。

推荐路径：使用 CLI 入门向导（openclaw onboard）。它会设置：

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

如果你想查看更深入的参考页面，跳转到：Wizard、Setup、Pairing、Security。

沙箱说明：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 tools。

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

1) 安装 CLI（推荐）

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

安装程序选项（安装方法、非交互式、从 GitHub）：Install。

Windows（PowerShell）：

iwr -useb https://openclaw.ai/install.ps1 | iex

替代方案（全局安装）：

npm install -g openclaw@latest

pnpm add -g openclaw@latest

2) 运行入门向导（并安装服务）

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 中。

向导文档：Wizard

认证：它存储在哪里（重要）

  • 推荐的 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) 启动网关（Gateway）

如果你在入门时安装了服务，网关应该已经在运行：

openclaw gateway status

手动运行（前台）：

openclaw gateway --port 18789 --verbose

仪表板（Dashboard）（本地回环）：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 --deep

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

WhatsApp（二维码登录）

openclaw channels login

通过 WhatsApp → 设置 → 已关联的设备扫描。

WhatsApp 文档：WhatsApp

Telegram / Discord / 其他

向导可以为你编写令牌/配置。如果你更喜欢手动配置，从以下开始：

Telegram 私信提示： 你的第一条私信会返回一个配对码。批准它（见下一步），否则机器人不会响应。

5) 私信安全（配对审批）

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

openclaw pairing list whatsapp
openclaw pairing approve whatsapp <code>

配对文档：Pairing

从源代码（开发）

如果你正在修改 OpenClaw 本身，从源代码运行：

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

如果你还没有全局安装，通过 pnpm openclaw ... 从仓库运行入门步骤。 pnpm build 也会打包 A2UI 资产；如果你只需要运行该步骤，使用 pnpm canvas:a2ui:bundle。

网关（Gateway）（从此仓库）：

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

7) 验证端到端

在新终端中，发送测试消息：

openclaw message send --target +15555550123 --message "Hello from OpenClaw"

如果 openclaw health 显示 "no auth configured"，返回向导并设置 OAuth/密钥认证——没有它，代理将无法响应。

提示：openclaw status --all 是最好的可粘贴、只读调试报告。 健康探测：openclaw health（或 openclaw status --deep）向运行中的网关请求健康快照。

下一步（可选，但很棒）

← 返回文档首页