10 KiB
| read_when | summary | title | x-i18n | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
OpenClaw 的顶层概述、功能和用途 | OpenClaw |
|
OpenClaw 🦞
"EXFOLIATE! EXFOLIATE!" — 大概是一只太空龙虾说的
适用于任何操作系统的 WhatsApp/Telegram/Discord/iMessage AI 智能体（Pi）Gateway 网关。
插件可添加 Mattermost 等更多渠道。
发送消息，获取智能体响应——尽在口袋中。
GitHub · 发布版本 · 文档 · OpenClaw 助手设置
OpenClaw 将 WhatsApp（通过 WhatsApp Web / Baileys）、Telegram（Bot API / grammY）、Discord（Bot API / channels.discord.js）和 iMessage（imsg CLI）桥接到像 Pi 这样的编程智能体。插件可添加 Mattermost（Bot API + WebSocket）等更多渠道。 OpenClaw 也为 OpenClaw 助手提供支持。
从这里开始
- 从零开始新安装： 入门指南
- 引导式设置（推荐）： 向导（
openclaw onboard） - 打开仪表板（本地 Gateway 网关）： http://127.0.0.1:18789/（或 http://localhost:18789/）
如果 Gateway 网关运行在同一台计算机上，该链接会立即打开浏览器控制 UI。
如果失败，请先启动 Gateway 网关：openclaw gateway。
仪表板（浏览器控制 UI）
仪表板是用于聊天、配置、节点、会话等的浏览器控制 UI。 本地默认：http://127.0.0.1:18789/ 远程访问：Web 界面 和 Tailscale
工作原理
WhatsApp / Telegram / Discord / iMessage（+ 插件）
│
▼
┌───────────────────────────┐
│ Gateway 网关 │ ws://127.0.0.1:18789（仅 loopback）
│ （单一来源） │
│ │ http://<gateway-host>:18793
│ │ /__openclaw__/canvas/（Canvas 主机）
└───────────┬───────────────┘
│
├─ Pi 智能体（RPC）
├─ CLI（openclaw …）
├─ 聊天 UI（SwiftUI）
├─ macOS 应用（OpenClaw.app）
├─ iOS 节点，通过 Gateway WS + 配对
└─ Android 节点，通过 Gateway WS + 配对
大多数操作通过 Gateway 网关（openclaw gateway）进行，这是一个长期运行的单一进程，拥有渠道连接和 WebSocket 控制平面。
网络模型
- 每台主机一个 Gateway 网关（推荐）：它是唯一允许拥有 WhatsApp Web 会话的进程。如果你需要救援机器人或严格隔离，请使用隔离的配置文件和端口运行多个 Gateway 网关；参见多 Gateway 网关。
- loopback 优先：Gateway 网关 WS 默认为
ws://127.0.0.1:18789。- 向导现在默认生成 Gateway 网关令牌（即使是 loopback）。
- 对于 Tailnet 访问，运行
openclaw gateway --bind tailnet --token ...（非 loopback 绑定需要令牌）。
- 节点：连接到 Gateway 网关 WebSocket（根据需要通过 LAN/tailnet/SSH）；旧版 TCP 桥接已弃用/移除。
- Canvas 主机：在
canvasHost.port（默认18793）上的 HTTP 文件服务器，为节点 WebView 提供/__openclaw__/canvas/；参见 Gateway 网关配置（canvasHost）。 - 远程使用：SSH 隧道或 tailnet/VPN；参见远程访问和设备发现。
功能（高级概述）
- 📱 WhatsApp 集成 — 使用 Baileys 实现 WhatsApp Web 协议
- ✈️ Telegram 机器人 — 通过 grammY 支持私信 + 群组
- 🎮 Discord 机器人 — 通过 channels.discord.js 支持私信 + 服务器频道
- 🧩 Mattermost 机器人（插件） — 机器人令牌 + WebSocket 事件
- 💬 iMessage — 本地 imsg CLI 集成（macOS）
- 🤖 智能体桥接 — Pi（RPC 模式）支持工具流式传输
- ⏱️ 流式传输 + 分块 — 分块流式传输 + Telegram 草稿流式传输详情（/concepts/streaming）
- 🧠 多智能体路由 — 将提供商账户/对等方路由到隔离的智能体（工作区 + 每智能体会话）
- 🔐 订阅认证 — 通过 OAuth 支持 Anthropic（Claude Pro/Max）+ OpenAI（ChatGPT/Codex）
- 💬 会话 — 私聊折叠到共享的
main（默认）；群组是隔离的 - 👥 群聊支持 — 默认基于提及；所有者可切换
/activation always|mention - 📎 媒体支持 — 发送和接收图片、音频、文档
- 🎤 语音消息 — 可选的转录钩子
- 🖥️ WebChat + macOS 应用 — 本地 UI + 用于操作和语音唤醒的菜单栏配套应用
- 📱 iOS 节点 — 作为节点配对并暴露 Canvas 界面
- 📱 Android 节点 — 作为节点配对并暴露 Canvas + 聊天 + 相机
注意：旧版 Claude/Codex/Gemini/Opencode 路径已移除；Pi 是唯一的编程智能体路径。
快速开始
运行时要求：Node ≥ 22。
# 推荐：全局安装（npm/pnpm）
npm install -g openclaw@latest
# 或：pnpm add -g openclaw@latest
# 新手引导 + 安装服务（launchd/systemd 用户服务）
openclaw onboard --install-daemon
# 配对 WhatsApp Web（显示二维码）
openclaw channels login
# 新手引导后 Gateway 网关通过服务运行；手动运行仍然可行：
openclaw gateway --port 18789
之后在 npm 和 git 安装之间切换很简单：安装另一种方式并运行 openclaw doctor 来更新 Gateway 网关服务入口点。
从源代码（开发）：
git clone https://github.com/openclaw/openclaw.git
cd openclaw
pnpm install
pnpm ui:build # 首次运行时自动安装 UI 依赖
pnpm build
openclaw onboard --install-daemon
如果你还没有全局安装，请从仓库通过 pnpm openclaw ... 运行新手引导步骤。
多实例快速开始（可选）：
OPENCLAW_CONFIG_PATH=~/.openclaw/a.json \
OPENCLAW_STATE_DIR=~/.openclaw-a \
openclaw gateway --port 19001
发送测试消息（需要运行中的 Gateway 网关）：
openclaw message send --target +15555550123 --message "Hello from OpenClaw"
配置（可选）
配置位于 ~/.openclaw/openclaw.json。
- 如果你什么都不做，OpenClaw 会使用内置的 Pi 二进制文件以 RPC 模式运行，按发送者分会话。
- 如果你想锁定它，从
channels.whatsapp.allowFrom开始，以及（对于群组）提及规则。
示例：
{
channels: {
whatsapp: {
allowFrom: ["+15555550123"],
groups: { "*": { requireMention: true } },
},
},
messages: { groupChat: { mentionPatterns: ["@openclaw"] } },
}
文档
- 从这里开始：
- 提供商和用户体验：
- 配套应用：
- 运维和安全：
名称由来
OpenClaw = CLAW + TARDIS — 因为每只太空龙虾都需要一台时空机器。
"我们都只是在玩弄自己的提示词。" — 一个 AI，可能正处于 token 兴奋状态
致谢
- Peter Steinberger（@steipete）— 创建者，龙虾低语者
- Mario Zechner（@badlogicc）— Pi 创建者，安全渗透测试员
- Clawd — 那只要求更好名字的太空龙虾
核心贡献者
- Maxim Vovshin（@Hyaxia, 36747317+Hyaxia@users.noreply.github.com）— Blogwatcher skill
- Nacho Iacovino（@nachoiacovino, nacho.iacovino@gmail.com）— 位置解析（Telegram + WhatsApp）
许可证
MIT — 像海洋中的龙虾一样自由 🦞
"我们都只是在玩弄自己的提示词。" — 一个 AI，可能正处于 token 兴奋状态