README
- 原始链接:https://github.com/openclaw/openclaw/blob/main/README.md
- 来源章节:7. 官方仓库与生态仓库
- 来源小节:无
- 抓取方式:jina:https://r.jina.ai/http://github.com/openclaw/openclaw/blob/main/README.md
- 抓取时间:2026-04-05 13:47:10
- 状态:ok
中文内容
🦞 OpenClaw — 个人人工智能助理
去角质!去角质!
[](https://github.com/openclaw/openclaw/blob/main/LICENSE)
OpenClaw 是您在自己的设备上运行的_个人人工智能助手_。它会在您已使用的渠道(WhatsApp、Telegram、Slack、Discord、Google Chat、Signal、iMessage、BlueBubbles、IRC、Microsoft Teams、Matrix、飞书、LINE、Mattermost、Nextcloud Talk、Nostr、Synology Chat、Tlon、Twitch、Zalo、Zalo Personal、微信、WebChat)上答复您。它可以在 macOS/iOS/Android 上说话和听,并可以渲染您控制的实时画布。网关只是控制平面——产品是助手。
如果您想要一个感觉本地化、快速且始终在线的个人单用户助手,那么这就是它。
网站 · 文档 · 愿景 · DeepWiki · 入门 · 更新 · 展示 · 常见问题解答 · 入门 · Nix · Docker · Discord
首选设置:在终端中运行“openclaw onboard”。 OpenClaw Onboard 将指导您逐步设置网关、工作区、通道和技能。这是推荐的 CLI 设置路径,适用于 macOS、Linux 和 Windows(通过 WSL2;强烈推荐)。与 npm、pnpm 或 Bun 配合使用。新安装?从这里开始:入门
赞助商
- OpenAI (ChatGPT/Codex)
型号说明:虽然支持许多提供商/型号,但为了获得最佳体验并降低提示注入风险,请使用您可用的最强大的最新一代型号。请参阅入门。
模型(选择+验证)
安装(推荐)
npm install -g openclaw@latest
或:pnpm add -g openclaw@latest
openclaw 板载 --install-daemon
OpenClaw Onboard 安装网关守护进程(launchd/systemd 用户服务),使其保持运行。
快速入门(TL;DR)
完整的初学者指南(身份验证、配对、频道):入门
openclaw 板载 --install-daemon
openclaw 网关 --端口 18789 --verbose
发送消息
openclaw 消息发送 --to +1234567890 --message "Hello from OpenClaw"
与助手交谈(可选择传回任何连接的频道:WhatsApp/Telegram/Slack/Discord/Google Chat/Signal/iMessage/BlueBubbles/IRC/Microsoft Teams/Matrix/Feishu/LINE/Mattermost/Nextcloud Talk/Nostr/Synology Chat/Tlon/Twitch/Zalo/Zalo Personal/WeChat/WebChat)
openclaw 代理 -- 消息“船舶清单” -- 高思维
升级? 更新指南(并运行“openclaw doctor”)。
发展渠道
- 稳定:标记版本(
vYYYY.M.D或vYYYY.M.D-<patch>),npm dist-taglatest。 - beta:预发布标签 (
vYYYY.M.D-beta.N),npm dist-标签beta(macOS 应用程序可能丢失)。 - dev:移动
main的头部,npm dist-tagdev(发布时)。
切换频道(git + npm):openclaw update --channel stable|beta|dev。详细信息:开发渠道。
从源头(开发)
对于从源代码构建,更喜欢使用“pnpm”。对于直接运行 TypeScript,Bun 是可选的。
git 克隆 https://github.com/openclaw/openclaw.git CD张开爪
即插即用安装 pnpm ui:build # 首次运行时自动安装 UI 依赖项 PNPM 构建
pnpm openclaw onboard --install-daemon
开发循环(源/配置更改时自动重新加载)
pnpm 网关:watch
注意:“pnpm openclaw ...”直接运行 TypeScript(通过“tsx”)。 pnpm build 生成 dist/ 用于通过 Node / 打包的 openclaw 二进制文件运行。
安全默认值(DM 访问)
OpenClaw 连接到真实的消息传递界面。将入站 DM 视为不受信任的输入。
完整的安全指南:安全
Telegram/WhatsApp/Signal/iMessage/Microsoft Teams/Discord/Google Chat/Slack 上的默认行为:
- DM 配对 (
dmPolicy="pairing"/channels.discord.dmPolicy="pairing"/channels.slack.dmPolicy="pairing";传统:channels.discord.dm.policy、channels.slack.dm.policy):未知发件人收到简短的配对代码,机器人不会处理他们的消息。 - 批准方式:
openclawpairingapprove<channel><code>(然后发件人被添加到本地白名单存储中)。 - 公共入站 DM 需要明确选择加入:设置
dmPolicy="open"并在频道白名单中包含"*"(allowFrom/channels.discord.allowFrom/channels.slack.allowFrom;旧版:channels.discord.dm.allowFrom、channels.slack.dm.allowFrom)。
运行“openclaw doctor”以显示有风险/配置错误的 DM 策略。
亮点
- 本地优先网关 — 用于会话、通道、工具和事件的单一控制平面。
- 多渠道收件箱 — WhatsApp、Telegram、Slack、Discord、Google Chat、Signal、BlueBubbles (iMessage)、iMessage(旧版)、IRC、Microsoft Teams、Matrix、飞书、LINE、Mattermost、Nextcloud Talk、Nostr、Synology Chat、Tlon、Twitch、Zalo、Zalo Personal、微信、WebChat、macOS、iOS/Android。
- 多代理路由 — 将入站通道/帐户/对等点路由到隔离代理(工作区 + 每个代理会话)。
- 语音唤醒 + 通话模式 — macOS/iOS 上的唤醒词和 Android 上的连续语音(ElevenLabs + 系统 TTS 回退)。
- Live Canvas — 使用 A2UI 的代理驱动可视化工作区。
- 一流的工具 — 浏览器、画布、节点、cron、会话和 Discord
/行动迟缓。
明星历史

到目前为止我们构建的一切
核心平台
- Gateway WS 控制平面,包含会话、状态、配置、cron、webhooks、控制 UI 和 Canvas 主机。
- CLI界面:网关、代理、发送、onboarding和doctor。
- Pi 代理运行时 采用 RPC 模式,具有工具流和块流。
- 会话模型:
main用于直接聊天、群组隔离、激活模式、队列模式、回复。群组规则:群组。 - 媒体管道:图像/音频/视频、转录挂钩、大小上限、临时文件生命周期。音频详细信息:音频。
频道
- 频道: WhatsApp (Baileys)、Telegram (grammY)、Slack (Bolt)、 Discord (discord.js)、Google 聊天 (聊天 API)、信号 (signal-cli)、BlueBubbles (iMessage、推荐)、iMessage(旧版 imsg)、IRC、Microsoft Teams、Matrix、 飞书、LINE、Mattermost、Nextcloud Talk、Nostr、 Synology Chat、[Tlon](https://docs.openclaw
.ai/channels/tlon)、Twitch、Zalo、Zalo 个人、微信 (@tencent-weixin/openclaw-weixin)、 网络聊天。
应用程序+节点
- macOS 应用程序:菜单栏控制平面、语音唤醒/PTT、通话模式 叠加、WebChat、调试工具、远程网关控制。
- iOS 节点:画布、语音唤醒、通话模式、摄像头、屏幕录制、Bonjour + 设备配对。
- Android 节点:连接选项卡(设置代码/手册)、聊天会话、语音选项卡、画布、相机/屏幕录制和 Android 设备命令(通知/位置/短信/照片/联系人/日历/运动/应用程序更新)。
- macOS 节点模式: system.run/notify + canvas/camera 曝光。
工具+自动化
- 浏览器控制:专用的openclaw Chrome/Chromium、快照、操作、上传、配置文件。
- Canvas: A2UI 推送/重置、评估、快照。
- 节点:相机快照/剪辑、屏幕记录、location.get、通知。
- Cron + 唤醒; webhooks; Gmail Pub/Sub。
- 技能平台:通过安装控制 + UI 捆绑、管理和工作区技能。
运行时 + 安全
操作+包装
- 控制 UI + WebChat 直接从网关提供服务。
- Tailscale Serve/Funnel 或 SSH 隧道 以及令牌/密码身份验证。
- Nix 模式 用于声明性配置;基于 Docker 的安装。
- Doctor 迁移、logging。
它是如何工作的(简短)
WhatsApp / Telegram / Slack / Discord / Google Chat / Signal / iMessage / BlueBubbles / IRC / Microsoft Teams / Matrix / Feishu / LINE / Mattermost / Nextcloud Talk / Nostr / Synology Chat / Tlon / Twitch / Zalo / Zalo Personal / 微信 / WebChat
│
▼
┌────────────────────────────────┐
│ 网关 │
│ (控制平面) │
│ ws://127.0.0.1:18789 │
└──────────────┬────────────────┘
│
├─ Pi 代理(RPC)
├─ CLI(张开爪……)
├─ 网络聊天界面
├─ macOS 应用程序
└─ iOS / Android 节点关键子系统
- 网关 WebSocket 网络 — 用于客户端、工具和事件的单一 WS 控制平面(加上操作:网关运行手册)。
- Tailscale 曝光 — 网关仪表板 + WS 的服务/漏斗(远程访问:Remote)。
- 浏览器控制 — openclaw 管理的 Chrome/Chromium,具有 CDP 控制。
- Canvas + A2UI — 代理驱动的可视化工作区(A2UI 主机:Canvas/A2UI)。
- 语音唤醒 + 通话模式 — macOS/iOS 上的唤醒词以及 Android 上的连续语音。
- Nodes — 画布、相机快照/剪辑、屏幕记录、
location.get、通知以及仅限 macOS 的system.run/system.notify。
Tailscale 访问(网关仪表板)
OpenClaw 可以自动配置 Tailscale Serve(仅限 tailnet)或 Funnel(公共),同时网关保持绑定到环回。配置gateway.tailscale.mode:
off:无 Tailscale 自动化(默认)。serve:通过tailscaleserve的仅限 tailnet 的 HTTPS(默认使用 Tailscale 身份标头)。funnel:通过tailscale funnel的公共 HTTPS(需要共享密码身份验证)。
注意事项:
- 当启用 Serve/Funnel 时,
gateway.bind必须保持loopback(OpenClaw 强制执行此操作)。 - 通过设置
gateway.auth.mode: "password"或gateway.auth.allowTailscale: false可以强制服务需要密码。 - 除非设置
gateway.auth.mode: "password",否则漏斗将拒绝启动。 - 可选:
gateway.tailscale.resetOnExit用于在关闭时撤消服务/漏斗。
详细信息: Tailscale 指南 · Web 界面
远程网关(Linux 很棒)
在小型 Linux 实例上运行网关完全没问题。客户端(macOS 应用程序、CLI、WebChat)可以通过 Tailscale Serve/Funnel 或 SSH 隧道 进行连接,并且您仍然可以在需要时配对设备节点 (macOS/iOS/Android) 以执行设备本地操作。
- 网关主机默认运行执行工具和通道连接。
- 设备节点通过“node.invoke”运行设备本地操作(“system.run”、摄像头、屏幕录制、通知)。简而言之: exec 在网关所在的地方运行;设备操作在设备所在的位置运行。
通过网关协议的 macOS 权限
macOS 应用程序可以在 节点模式 下运行,并通过网关 WebSocket(node.list / node.describe)公布其功能 + 权限映射。然后,客户端可以通过“node.invoke”执行本地操作:
system.run运行本地命令并返回 stdout/stderr/退出代码;设置needsScreenRecording: true来要求屏幕录制权限(否则你会得到PERMISSION_MISSING)。system.notify发布用户通知,如果通知被拒绝,则失败。canvas.*、camera.*、screen.record和location.get也通过node.invoke路由并遵循 TCC 权限状态。
提升的 bash(主机权限)与 macOS TCC 是分开的:
- 在启用 + 列入白名单时,使用“/elevated on|off”切换每个会话的提升访问权限。
- 网关通过“sessions.patch”(WS 方法)以及“thinkingLevel”、“verboseLevel”、“model”、“sendPolicy”和“groupActivation”保留每个会话的切换。
详细信息: 节点 · macOS 应用程序 · 网关协议
代理到代理(sessions_* 工具)
- 使用它们来协调跨会话的工作,而无需在聊天界面之间跳转。
sessions_list— 发现活动会话(代理)及其元数据。sessions_history— 获取会话的记录日志。sessions_send— 向另一个会话发送消息;可选的回复乒乓+宣布步骤(REPLY_SKIP,ANNOUNCE_SKIP)。
详细信息:会话工具
技能注册表(ClawHub)
ClawHub 是一个最小的技能注册表。启用 ClawHub 后,代理可以自动搜索技能并根据需要引入新技能。
聊天命令
在 WhatsApp/Telegram/Slack/Google Chat/Microsoft Teams/WebChat 中发送这些内容(群组命令仅供所有者使用):
/status— 紧凑的会话状态(模型+令牌,可用时的成本)/new或/reset— 重置会话/compact— 紧凑的会话上下文(摘要)/think <level>— off|minimal|low|medium|high|xhigh(仅限 GPT-5.2 + Codex 型号)/详细打开|关闭/usage off|tokens|full— 每个响应的使用页脚/restart— 重新启动网关(仅限组中的所有者)/activation提及|always— 组激活切换(仅限组)
应用程序(可选)
仅 Gateway 就提供了出色的体验。所有应用程序都是可选的并添加额外的功能。
如果您计划构建/运行配套应用程序,请遵循下面的平台操作手册。
macOS (OpenClaw.app)(可选)
- 菜单栏控制网关和健康。
- 语音唤醒 + 一键通覆盖。
- WebChat + 调试工具。
- 通过 SSH 进行远程网关控制。
注意:macOS 权限需要签名构建才能在重建过程中保持不变(请参阅 macOS 权限)。
iOS 节点(可选)
- 通过网关 WebSocket 作为节点配对(设备配对)。
- 语音触发转发+Canvas表面。
- 通过“openclaw 节点……”控制。
运行手册:iOS 连接。
Android 节点(可选)
- 通过设备配对(“openclaw devices ...”)作为 WS 节点进行配对。
- 公开连接/聊天/语音选项卡以及画布、相机、屏幕捕获和 Android 设备命令系列。
- 运行手册:Android 连接。
代理工作区 + 技能
- 工作空间根目录:
~/.openclaw/workspace(可通过agents.defaults.workspace配置)。 - 注入提示文件:
AGENTS.md、SOUL.md、TOOLS.md。 - 技能:
~/.openclaw/workspace/skills/<skill>/SKILL.md。
配置
最小~/.openclaw/openclaw.json(模型+默认值):
{ 代理人:{ 型号:“anthropic/claude-opus-4-6”, }, }
安全模型(重要)
- 默认: 工具在主机上运行 主 会话,因此当只有您时,代理具有完全访问权限。
- 组/通道安全: 设置
agents.defaults.sandbox.mode: "non-main"以在每个会话 Docker 沙箱内运行 非主会话(组/通道);然后 bash 在 Docker 中运行这些会话。 - **沙箱默认值:**允许列表
bash、process、read、write、edit、sessions_list、sessions_history、sessions_send、sessions_spawn;拒绝列表“浏览器”、“画布”、“节点”、“cron”、“不和谐”、“网关”。
详细信息: 安全指南 · Docker + 沙箱 · 沙箱配置
- 链接设备:“pnpm openclaw 通道登录”(将凭证存储在“~/.openclaw/credentials”中)。
- 将可以通过“channels.whatsapp.allowFrom”与助理交谈的人列入白名单。
- 如果设置了
channels.whatsapp.groups,则它成为群组白名单;包含“*”以允许所有。
电报
- 设置
TELEGRAM_BOT_TOKEN或channels.telegram.botToken(env 获胜)。 - 可选:设置
channels.telegram.groups(使用channels.telegram.groups."*".requireMention);设置后,它是一个组白名单(包括“*”以允许所有)。还可以根据需要使用“channels.telegram.allowFrom”或“channels.telegram.webhookUrl”+“channels.telegram.webhookSecret”。
{ 频道:{ 电报:{ botToken: "123456:ABCDEF", }, }, }
Slack
- 设置
SLACK_BOT_TOKEN+SLACK_APP_TOKEN(或channels.slack.botToken+channels.slack.appToken)。
Discord
- 设置
DISCORD_BOT_TOKEN或channels.discord.token。 - 可选:根据需要设置
commands.native、commands.text或commands.useAccessGroups,加上channels.discord.allowFrom、channels.discord.guilds或channels.discord.mediaMaxMb。
{ 频道:{ 不和谐:{ 令牌:“1234abcd”, }, }, }
信号
- 需要
signal-cli和channels.signal配置部分。
BlueBubbles (iMessage)
- 推荐 iMessage 集成。
- 配置
channels.bluebubbles.serverUrl+channels.bluebubbles.password和一个 webhook (channels.bluebubbles.webhookPath)。 - BlueBubbles 服务器在 macOS 上运行; Gateway 可以在 macOS 或其他地方运行。
iMessage(旧版)
- 通过“imsg”进行旧版 macOS 集成(消息必须登录)。
- 如果设置了
channels.imessage.groups,则成为组白名单;包含“*”以允许所有。
Microsoft Teams
- 配置 Teams 应用程序 + Bot 框架,然后添加
msteams配置部分。 - 列入允许通过
msteams.allowFrom通话的人员;通过msteams.groupAllowFrom或msteams.groupPolicy: "open"进行组访问。
###微信
- 通过
@tencent-weixin/openclaw-weixin的官方腾讯插件(iLink Bot API)。仅限私人聊天; v2.x 需要 OpenClaw>=2026.3.22。 - 安装:
openclaw插件安装“@tencent-weixin/openclaw-weixin”,然后openclaw频道登录--channel openclaw-weixin扫描二维码。 - 需要微信ClawBot插件(微信>我的>设置>插件);腾讯逐步推出。
网络聊天
- 使用网关WebSocket;没有单独的 WebChat 端口/配置。
浏览器控制(可选):
{ 浏览器:{ 启用:真, 颜色:“#FF4500”, }, }
文档
- 从文档索引开始进行导航和“什么在哪里。”
- 阅读网关+协议模型的架构概述。
- 当您需要每个密钥和示例时,请使用完整的配置参考。
- 使用操作手册按照手册运行网关。
- 了解控制 UI/Web 界面如何工作以及如何安全地公开它们。
- 了解通过 SSH 隧道或尾网的远程访问。
- 按照 OpenClaw Onboard 进行指导设置。
- 通过 webhook 表面连接外部触发器。
- 设置 Gmail Pub/Sub 触发器。
- 了解 macOS 菜单栏配套详细信息。
- 平台指南:Windows (WSL2)、Linux、macOS
高级文档(发现+控制)
操作和故障排除
深入研究
工作空间和技能
平台内部结构
电子邮件挂钩 (Gmail)
莫尔蒂
OpenClaw 是为太空龙虾人工智能助手 Molty 构建的。 🦞 作者:Peter Steinberger 和社区。
社区
请参阅 CONTRIBUTING.md 了解指南、维护者以及如何提交 PR。欢迎 AI/vibe 编码的 PR! 🤖
特别感谢 Mario Zechner 的支持和 pi-mono。特别感谢 Adam Doppelt 的 lobster.bot。
感谢所有爪友贡献者:
[![图片12:sebslight](https://avatars.githubuserco
说明:该页面原文较长,已翻译前半部分;完整原文请查看原始链接。