跳转到主要内容

OpenClaw 🦞

“EXFOLIATE! EXFOLIATE!” — 也许是一只太空龙虾

OpenClaw

Any OS + WhatsApp/Telegram/Discord/iMessage 网关,面向 AI agent(Pi)。
插件可添加 Mattermost 等。 发条消息,口袋里就能收到 agent 回复。

GitHub · Releases · Docs · OpenClaw assistant setup

OpenClaw 将 WhatsApp(WhatsApp Web / Baileys)、Telegram(Bot API / grammY)、Discord(Bot API / channels.discord.js)与 iMessage(imsg CLI)桥接到如 Pi 的编码 agent。插件还可接入 Mattermost(Bot API + WebSocket)等。 OpenClaw 也驱动 OpenClaw assistant。

Start here

如果 Gateway 运行在同一台电脑上,该链接会直接打开浏览器 Control UI。 如果打不开,先启动 Gateway:openclaw gateway

Dashboard(浏览器 Control UI)

Dashboard 是浏览器里的 Control UI,用于聊天、配置、节点、会话等。 本地默认:http://127.0.0.1:18789/ 远程访问见:Web surfacesTailscale

OpenClaw

How it works

WhatsApp / Telegram / Discord / iMessage (+ plugins)


  ┌───────────────────────────┐
  │          Gateway          │  ws://127.0.0.1:18789 (loopback-only)
  │     (single source)       │
  │                           │  http://<gateway-host>:18793
  │                           │    /__openclaw__/canvas/ (Canvas host)
  └───────────┬───────────────┘

              ├─ Pi agent (RPC)
              ├─ CLI (openclaw …)
              ├─ Chat UI (SwiftUI)
              ├─ macOS app (OpenClaw.app)
              ├─ iOS node via Gateway WS + pairing
              └─ Android node via Gateway WS + pairing
大多数操作都通过 Gatewayopenclaw gateway)流转,它是一个长期运行的单一进程,负责管理频道连接与 WebSocket 控制平面。

Network model

  • 每台主机一个 Gateway(推荐):它是唯一允许持有 WhatsApp Web 会话的进程。如果需要救援 bot 或强隔离,可用隔离的 profile 与端口运行多个网关;见 Multiple gateways
  • Loopback-first:Gateway WS 默认为 ws://127.0.0.1:18789
    • 向导现在默认生成 gateway token(即便是 loopback)。
    • Tailnet 访问用:openclaw gateway --bind tailnet --token ...(非 loopback 绑定必须带 token)。
  • Nodes:通过 Gateway WebSocket 连接(按需用 LAN/tailnet/SSH);旧 TCP bridge 已弃用/移除。
  • Canvas host:HTTP 文件服务运行在 canvasHost.port(默认 18793),提供 /__openclaw__/canvas/ 供 node WebView 使用;见 Gateway configurationcanvasHost)。
  • 远程使用:SSH 隧道或 tailnet/VPN;见 Remote accessDiscovery

Features(高层概览)

  • 📱 WhatsApp 集成 — 使用 Baileys 的 WhatsApp Web 协议
  • ✈️ Telegram Bot — grammY 支持 DMs + 群组
  • 🎮 Discord Bot — channels.discord.js 支持 DMs + 服务器频道
  • 🧩 Mattermost Bot(插件) — Bot token + WebSocket 事件
  • 💬 iMessage — 本地 imsg CLI 集成(macOS)
  • 🤖 Agent bridge — Pi(RPC 模式)+ 工具流式
  • ⏱️ Streaming + chunking — 分块流式 + Telegram 草稿流式细节(/concepts/streaming
  • 🧠 多 agent 路由 — 把 provider 账号/peer 路由到隔离的 agent(workspace + 每 agent 会话)
  • 🔐 订阅认证 — Anthropic(Claude Pro/Max)+ OpenAI(ChatGPT/Codex)OAuth
  • 💬 Sessions — 直聊默认合并到 main;群组独立
  • 👥 群聊支持 — 默认基于提及;owner 可切换 /activation always|mention
  • 📎 媒体支持 — 发送/接收图片、音频、文档
  • 🎤 语音消息 — 可选转写 hook
  • 🖥️ WebChat + macOS app — 本地 UI + 菜单栏伴侣用于运维与语音唤醒
  • 📱 iOS node — 作为节点配对并提供 Canvas
  • 📱 Android node — 作为节点配对并提供 Canvas + Chat + Camera
注意:旧的 Claude/Codex/Gemini/Opencode 路径已移除;Pi 是唯一的编码 agent 路径。

Quick start

运行时要求:Node ≥ 22
# 推荐:全局安装(npm/pnpm)
npm install -g openclaw@latest
# or: pnpm add -g openclaw@latest

# Onboard + 安装服务(launchd/systemd 用户服务)
openclaw onboard --install-daemon

# 配对 WhatsApp Web(显示二维码)
openclaw channels login

# Onboarding 后 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 ... 运行 onboarding。 多实例快速启动(可选):
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"

Configuration(可选)

配置位于 ~/.openclaw/openclaw.json
  • 不做任何配置时,OpenClaw 会使用内置 Pi 二进制(RPC 模式)+ 按发送者划分会话。
  • 如果要更严格的安全控制,先从 channels.whatsapp.allowFrom 和(群组)提及规则开始。
示例:
{
  channels: {
    whatsapp: {
      allowFrom: ["+15555550123"],
      groups: { "*": { requireMention: true } }
    }
  },
  messages: { groupChat: { mentionPatterns: ["@openclaw"] } }
}

Docs

The name

OpenClaw = CLAW + TARDIS — 因为每只太空龙虾都需要一台时间与空间机器。
“We’re all just playing with our own prompts.” — 也许是一位 token 上头的 AI

Credits

  • Peter Steinberger (@steipete) — Creator, lobster whisperer
  • Mario Zechner (@badlogicc) — Pi creator, security pen-tester
  • Clawd — 那只要求更好名字的太空龙虾

Core Contributors

License

MIT — 像海里的龙虾一样自由 🦞
“We’re all just playing with our own prompts.” — 也许是一位 token 上头的 AI