mirror of
https://github.com/farcasclaudiu/openclaw.git
synced 2026-06-28 19:01:47 +03:00
docs: canonicalize docs paths and align zh navigation (#11428)
* docs(navigation): canonicalize paths and align zh nav * chore(docs): remove stray .DS_Store * docs(scripts): add non-mint docs link audit * docs(nav): fix zh source paths and preserve legacy redirects (#11428) (thanks @sebslight) * chore(docs): satisfy lint for docs link audit script (#11428) (thanks @sebslight)
This commit is contained in:
@@ -9,7 +9,7 @@ x-i18n:
|
||||
model: claude-opus-4-5
|
||||
provider: pi
|
||||
source_hash: 853227a0f1abd20790b425fa64dda60efc6b5f93c1b13ecd2dcb788268f71d79
|
||||
source_path: hooks.md
|
||||
source_path: automation/hooks.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
@@ -24,7 +24,7 @@ Hooks 是在事件发生时运行的小脚本。有两种类型:
|
||||
- **Hooks**(本页):当智能体事件触发时在 Gateway 网关内运行,如 `/new`、`/reset`、`/stop` 或生命周期事件。
|
||||
- **Webhooks**:外部 HTTP webhooks,让其他系统触发 OpenClaw 中的工作。参见 [Webhook Hooks](/automation/webhook) 或使用 `openclaw webhooks` 获取 Gmail 助手命令。
|
||||
|
||||
Hooks 也可以捆绑在插件中;参见 [插件](/plugin#plugin-hooks)。
|
||||
Hooks 也可以捆绑在插件中;参见 [插件](/tools/plugin#plugin-hooks)。
|
||||
|
||||
常见用途:
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
summary: 自动化故障排查:排查 cron 和 heartbeat 调度与投递问题
|
||||
title: 自动化故障排查
|
||||
---
|
||||
|
||||
# 自动化故障排查
|
||||
|
||||
该页面是英文文档的中文占位版本,完整内容请先参考英文版:[Automation Troubleshooting](/automation/troubleshooting)。
|
||||
@@ -25,7 +25,7 @@ x-i18n:
|
||||
- OpenClaw 通过其 REST API 与之通信(`GET /api/v1/ping`、`POST /message/text`、`POST /chat/:id/*`)。
|
||||
- 传入消息通过 webhook 到达;发出的回复、输入指示器、已读回执和 tapback 均为 REST 调用。
|
||||
- 附件和贴纸作为入站媒体被接收(并在可能时呈现给智能体)。
|
||||
- 配对/白名单的工作方式与其他渠道相同(`/start/pairing` 等),使用 `channels.bluebubbles.allowFrom` + 配对码。
|
||||
- 配对/白名单的工作方式与其他渠道相同(`/channels/pairing` 等),使用 `channels.bluebubbles.allowFrom` + 配对码。
|
||||
- 回应作为系统事件呈现,与 Slack/Telegram 类似,智能体可以在回复前"提及"它们。
|
||||
- 高级功能:编辑、撤回、回复线程、消息效果、群组管理。
|
||||
|
||||
@@ -80,7 +80,7 @@ openclaw channels add bluebubbles --http-url http://192.168.1.100:1234 --passwor
|
||||
- 批准方式:
|
||||
- `openclaw pairing list bluebubbles`
|
||||
- `openclaw pairing approve bluebubbles <CODE>`
|
||||
- 配对是默认的令牌交换方式。详情:[配对](/start/pairing)
|
||||
- 配对是默认的令牌交换方式。详情:[配对](/channels/pairing)
|
||||
|
||||
群组:
|
||||
|
||||
@@ -268,4 +268,4 @@ OpenClaw 可能会显示*短*消息 ID(例如 `1`、`2`)以节省 token。
|
||||
- OpenClaw 会根据 BlueBubbles 服务器的 macOS 版本自动隐藏已知不可用的操作。如果在 macOS 26(Tahoe)上编辑仍然显示,请使用 `channels.bluebubbles.actions.edit=false` 手动禁用。
|
||||
- 查看状态/健康信息:`openclaw status --all` 或 `openclaw status --deep`。
|
||||
|
||||
有关通用渠道工作流参考,请参阅[渠道](/channels)和[插件](/plugins)指南。
|
||||
有关通用渠道工作流参考,请参阅[渠道](/channels)和[插件](/tools/plugin)指南。
|
||||
|
||||
@@ -10,7 +10,7 @@ x-i18n:
|
||||
model: claude-opus-4-5
|
||||
provider: pi
|
||||
source_hash: eaeb4035912c49413e012177cf0bd28b348130d30d3317674418dca728229b70
|
||||
source_path: broadcast-groups.md
|
||||
source_path: channels/broadcast-groups.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
@@ -444,6 +444,6 @@ interface OpenClawConfig {
|
||||
|
||||
## 另请参阅
|
||||
|
||||
- [多智能体配置](/multi-agent-sandbox-tools)
|
||||
- [路由配置](/concepts/channel-routing)
|
||||
- [多智能体配置](/tools/multi-agent-sandbox-tools)
|
||||
- [路由配置](/channels/channel-routing)
|
||||
- [会话管理](/concepts/sessions)
|
||||
@@ -8,7 +8,7 @@ x-i18n:
|
||||
model: claude-opus-4-5
|
||||
provider: pi
|
||||
source_hash: 1a322b5187e32c82fc1e8aac02437e2eeb7ba84e7b3a1db89feeab1dcf7dbbab
|
||||
source_path: concepts/channel-routing.md
|
||||
source_path: channels/channel-routing.md
|
||||
workflow: 14
|
||||
---
|
||||
|
||||
@@ -73,7 +73,7 @@ OpenClaw 将回复**路由回消息来源的渠道**。模型不会选择渠道
|
||||
}
|
||||
```
|
||||
|
||||
参见:[广播组](/broadcast-groups)。
|
||||
参见:[广播组](/channels/broadcast-groups)。
|
||||
|
||||
## 配置概览
|
||||
|
||||
@@ -8,7 +8,7 @@ x-i18n:
|
||||
model: claude-opus-4-5
|
||||
provider: pi
|
||||
source_hash: 181a72f12f5021af77c2e4c913120f711e0c0bc271d218d75cb6fe80dab675bb
|
||||
source_path: concepts/group-messages.md
|
||||
source_path: channels/group-messages.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
@@ -8,7 +8,7 @@ x-i18n:
|
||||
model: claude-opus-4-5
|
||||
provider: pi
|
||||
source_hash: b727a053edf51f6e7b5c0c324c2fc9c9789a9796c37f622418bd555e8b5a0ec4
|
||||
source_path: concepts/groups.md
|
||||
source_path: channels/groups.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
@@ -376,4 +376,4 @@ requireMention? 是 -> 被提及? 否 -> 仅存储为上下文
|
||||
|
||||
## WhatsApp 特定内容
|
||||
|
||||
参见[群消息](/concepts/group-messages)了解 WhatsApp 专有行为(历史注入、提及处理详情)。
|
||||
参见[群消息](/channels/group-messages)了解 WhatsApp 专有行为(历史注入、提及处理详情)。
|
||||
@@ -205,7 +205,7 @@ exec ssh -T bot@mac-mini.tailnet-1234.ts.net imsg "$@"
|
||||
- 批准方式:
|
||||
- `openclaw pairing list imessage`
|
||||
- `openclaw pairing approve imessage <CODE>`
|
||||
- 配对是 iMessage 私信的默认令牌交换方式。详情:[配对](/start/pairing)
|
||||
- 配对是 iMessage 私信的默认令牌交换方式。详情:[配对](/channels/pairing)
|
||||
|
||||
群组:
|
||||
|
||||
|
||||
@@ -46,7 +46,7 @@ OpenClaw 可以在你已经使用的任何聊天应用上与你交流。每个
|
||||
- 渠道可以同时运行;配置多个渠道后,OpenClaw 会按聊天进行路由。
|
||||
- 最快的设置方式通常是 **Telegram**(简单的机器人令牌)。WhatsApp 需要二维码配对,
|
||||
并在磁盘上存储更多状态。
|
||||
- 群组行为因渠道而异;参见[群组](/concepts/groups)。
|
||||
- 群组行为因渠道而异;参见[群组](/channels/groups)。
|
||||
- 为安全起见,私信配对和允许列表会被强制执行;参见[安全](/gateway/security)。
|
||||
- Telegram 内部机制:[grammY 说明](/channels/grammy)。
|
||||
- 故障排除:[渠道故障排除](/channels/troubleshooting)。
|
||||
|
||||
@@ -36,7 +36,7 @@ openclaw plugins install ./extensions/matrix
|
||||
|
||||
如果你在配置/新手引导期间选择 Matrix 并检测到 git 检出,OpenClaw 将自动提供本地安装路径。
|
||||
|
||||
详情:[插件](/plugin)
|
||||
详情:[插件](/tools/plugin)
|
||||
|
||||
## 设置
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ openclaw plugins install ./extensions/mattermost
|
||||
|
||||
如果你在配置/新手引导期间选择 Mattermost 并检测到 git 检出,OpenClaw 会自动提供本地安装路径。
|
||||
|
||||
详情:[插件](/plugin)
|
||||
详情:[插件](/tools/plugin)
|
||||
|
||||
## 快速设置
|
||||
|
||||
|
||||
@@ -43,7 +43,7 @@ openclaw plugins install ./extensions/msteams
|
||||
如果你在配置/新手引导过程中选择 Teams 并检测到 git 检出,
|
||||
OpenClaw 将自动提供本地安装路径。
|
||||
|
||||
详情:[插件](/plugin)
|
||||
详情:[插件](/tools/plugin)
|
||||
|
||||
## 快速设置(初学者)
|
||||
|
||||
|
||||
@@ -35,7 +35,7 @@ openclaw plugins install ./extensions/nextcloud-talk
|
||||
如果你在配置/新手引导过程中选择了 Nextcloud Talk,并且检测到 git 检出,
|
||||
OpenClaw 将自动提供本地安装路径。
|
||||
|
||||
详情:[插件](/plugin)
|
||||
详情:[插件](/tools/plugin)
|
||||
|
||||
## 快速设置(新手)
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ x-i18n:
|
||||
model: claude-opus-4-5
|
||||
provider: pi
|
||||
source_hash: c46a5c39f289c8fd0783baacd927f550c3d3ae8889a7bc7de133b795f16fa08a
|
||||
source_path: start/pairing.md
|
||||
source_path: channels/pairing.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
@@ -116,7 +116,7 @@ x-i18n:
|
||||
- 通过以下方式批准:
|
||||
- `openclaw pairing list signal`
|
||||
- `openclaw pairing approve signal <CODE>`
|
||||
- 配对是 Signal 私信的默认令牌交换方式。详情:[配对](/start/pairing)
|
||||
- 配对是 Signal 私信的默认令牌交换方式。详情:[配对](/channels/pairing)
|
||||
- 仅有 UUID 的发送者(来自 `sourceUuid`)在 `channels.signal.allowFrom` 中存储为 `uuid:<id>`。
|
||||
|
||||
群组:
|
||||
|
||||
@@ -356,7 +356,7 @@ Telegram 功能可以在两个级别配置(上面显示的对象形式;旧
|
||||
- 批准方式:
|
||||
- `openclaw pairing list telegram`
|
||||
- `openclaw pairing approve telegram <CODE>`
|
||||
- 配对是 Telegram 私信使用的默认 token 交换。详情:[配对](/start/pairing)
|
||||
- 配对是 Telegram 私信使用的默认 token 交换。详情:[配对](/channels/pairing)
|
||||
- `channels.telegram.allowFrom` 接受数字用户 ID(推荐)或 `@username` 条目。这**不是**机器人用户名;使用人类发送者的 ID。向导接受 `@username` 并在可能时将其解析为数字 ID。
|
||||
|
||||
#### 查找你的 Telegram 用户 ID
|
||||
|
||||
@@ -34,7 +34,7 @@ openclaw plugins install @openclaw/tlon
|
||||
openclaw plugins install ./extensions/tlon
|
||||
```
|
||||
|
||||
详情:[插件](/plugin)
|
||||
详情:[插件](/tools/plugin)
|
||||
|
||||
## 设置
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ openclaw plugins install @openclaw/twitch
|
||||
openclaw plugins install ./extensions/twitch
|
||||
```
|
||||
|
||||
详情:[插件](/plugin)
|
||||
详情:[插件](/tools/plugin)
|
||||
|
||||
## 快速设置(新手)
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ Zalo 以插件形式提供,不包含在核心安装中。
|
||||
|
||||
- 通过 CLI 安装:`openclaw plugins install @openclaw/zalo`
|
||||
- 或在新手引导期间选择 **Zalo** 并确认安装提示
|
||||
- 详情:[插件](/plugin)
|
||||
- 详情:[插件](/tools/plugin)
|
||||
|
||||
## 快速设置(初学者)
|
||||
|
||||
@@ -111,7 +111,7 @@ Zalo 是一款专注于越南市场的即时通讯应用;其 Bot API 让 Gatew
|
||||
- 通过以下方式批准:
|
||||
- `openclaw pairing list zalo`
|
||||
- `openclaw pairing approve zalo <CODE>`
|
||||
- 配对是默认的令牌交换方式。详情:[配对](/start/pairing)
|
||||
- 配对是默认的令牌交换方式。详情:[配对](/channels/pairing)
|
||||
- `channels.zalo.allowFrom` 接受数字用户 ID(无用户名查找功能)。
|
||||
|
||||
## 长轮询与 webhook
|
||||
|
||||
@@ -25,7 +25,7 @@ Zalo Personal 作为插件提供,不包含在核心安装中。
|
||||
|
||||
- 通过 CLI 安装:`openclaw plugins install @openclaw/zalouser`
|
||||
- 或从源码检出安装:`openclaw plugins install ./extensions/zalouser`
|
||||
- 详情:[插件](/plugin)
|
||||
- 详情:[插件](/tools/plugin)
|
||||
|
||||
## 前置条件:zca-cli
|
||||
|
||||
|
||||
@@ -19,8 +19,8 @@ x-i18n:
|
||||
|
||||
相关内容:
|
||||
|
||||
- 钩子:[钩子](/hooks)
|
||||
- 插件钩子:[插件](/plugin#plugin-hooks)
|
||||
- 钩子:[钩子](/automation/hooks)
|
||||
- 插件钩子:[插件](/tools/plugin#plugin-hooks)
|
||||
|
||||
## 列出所有钩子
|
||||
|
||||
@@ -255,7 +255,7 @@ openclaw hooks enable session-memory
|
||||
|
||||
**输出:** `~/.openclaw/workspace/memory/YYYY-MM-DD-slug.md`
|
||||
|
||||
**参见:** [session-memory 文档](/hooks#session-memory)
|
||||
**参见:** [session-memory 文档](/automation/hooks#session-memory)
|
||||
|
||||
### command-logger
|
||||
|
||||
@@ -282,7 +282,7 @@ cat ~/.openclaw/logs/commands.log | jq .
|
||||
grep '"action":"new"' ~/.openclaw/logs/commands.log | jq .
|
||||
```
|
||||
|
||||
**参见:** [command-logger 文档](/hooks#command-logger)
|
||||
**参见:** [command-logger 文档](/automation/hooks#command-logger)
|
||||
|
||||
### soul-evil
|
||||
|
||||
@@ -308,4 +308,4 @@ openclaw hooks enable soul-evil
|
||||
openclaw hooks enable boot-md
|
||||
```
|
||||
|
||||
**参见:** [boot-md 文档](/hooks#boot-md)
|
||||
**参见:** [boot-md 文档](/automation/hooks#boot-md)
|
||||
|
||||
@@ -262,7 +262,7 @@ openclaw [--dev] [--profile <name>] <command>
|
||||
- `openclaw plugins enable <id>` / `disable <id>` — 切换 `plugins.entries.<id>.enabled`。
|
||||
- `openclaw plugins doctor` — 报告插件加载错误。
|
||||
|
||||
大多数插件更改需要重启 Gateway 网关。参见 [/plugin](/plugin)。
|
||||
大多数插件更改需要重启 Gateway 网关。参见 [/plugin](/tools/plugin)。
|
||||
|
||||
## 记忆
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ x-i18n:
|
||||
相关内容:
|
||||
|
||||
- 记忆概念:[记忆](/concepts/memory)
|
||||
- 插件:[插件](/plugins)
|
||||
- 插件:[插件](/tools/plugin)
|
||||
|
||||
## 示例
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ x-i18n:
|
||||
|
||||
相关内容:
|
||||
|
||||
- 配对流程:[配对](/start/pairing)
|
||||
- 配对流程:[配对](/channels/pairing)
|
||||
|
||||
## 命令
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@ x-i18n:
|
||||
|
||||
相关内容:
|
||||
|
||||
- 插件系统:[插件](/plugin)
|
||||
- 插件系统:[插件](/tools/plugin)
|
||||
- 插件清单 + 模式:[插件清单](/plugins/manifest)
|
||||
- 安全加固:[安全](/gateway/security)
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@ x-i18n:
|
||||
|
||||
相关:
|
||||
|
||||
- TUI 指南:[TUI](/tui)
|
||||
- TUI 指南:[TUI](/web/tui)
|
||||
|
||||
## 示例
|
||||
|
||||
|
||||
@@ -76,7 +76,7 @@ OpenClaw 有两个钩子系统:
|
||||
- **`agent:bootstrap`**:在系统提示最终确定之前构建引导文件时运行。用于添加/删除引导上下文文件。
|
||||
- **命令钩子**:`/new`、`/reset`、`/stop` 和其他命令事件(参见钩子文档)。
|
||||
|
||||
参见[钩子](/hooks)了解设置和示例。
|
||||
参见[钩子](/automation/hooks)了解设置和示例。
|
||||
|
||||
### 插件钩子(智能体 + Gateway 网关生命周期)
|
||||
|
||||
@@ -91,7 +91,7 @@ OpenClaw 有两个钩子系统:
|
||||
- **`session_start` / `session_end`**:会话生命周期边界。
|
||||
- **`gateway_start` / `gateway_stop`**:Gateway 网关生命周期事件。
|
||||
|
||||
参见[插件](/plugin#plugin-hooks)了解钩子 API 和注册详情。
|
||||
参见[插件](/tools/plugin#plugin-hooks)了解钩子 API 和注册详情。
|
||||
|
||||
## 流式传输 + 部分回复
|
||||
|
||||
|
||||
@@ -215,5 +215,5 @@ git push
|
||||
## 高级注意事项
|
||||
|
||||
- 多智能体路由可以为每个智能体使用不同的工作区。参见
|
||||
[渠道路由](/concepts/channel-routing) 了解路由配置。
|
||||
[渠道路由](/channels/channel-routing) 了解路由配置。
|
||||
- 如果启用了 `agents.defaults.sandbox`,非主会话可以在 `agents.defaults.sandbox.workspaceRoot` 下使用每会话沙箱工作区。
|
||||
|
||||
@@ -112,4 +112,4 @@ OpenClaw 复用 pi-mono 代码库的部分内容(模型/工具),但**会
|
||||
|
||||
---
|
||||
|
||||
_下一篇:[群聊](/concepts/group-messages)_ 🦞
|
||||
_下一篇:[群聊](/channels/group-messages)_ 🦞
|
||||
|
||||
@@ -92,7 +92,7 @@ Client Gateway
|
||||
- **非本地**连接必须签名 `connect.challenge` nonce 并需要明确批准。
|
||||
- Gateway 网关认证(`gateway.auth.*`)仍适用于**所有**连接,无论本地还是远程。
|
||||
|
||||
详情:[Gateway 网关协议](/gateway/protocol)、[配对](/start/pairing)、[安全](/gateway/security)。
|
||||
详情:[Gateway 网关协议](/gateway/protocol)、[配对](/channels/pairing)、[安全](/gateway/security)。
|
||||
|
||||
## 协议类型和代码生成
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@ x-i18n:
|
||||
- `/usage tokens` → 在正常回复后附加每次回复的使用量页脚。
|
||||
- `/compact` → 将较旧的历史总结为紧凑条目以释放窗口空间。
|
||||
|
||||
另请参阅:[斜杠命令](/tools/slash-commands)、[Token 使用与成本](/token-use)、[压缩](/concepts/compaction)。
|
||||
另请参阅:[斜杠命令](/tools/slash-commands)、[Token 使用与成本](/reference/token-use)、[压缩](/concepts/compaction)。
|
||||
|
||||
## 示例输出
|
||||
|
||||
|
||||
@@ -129,7 +129,7 @@ OpenClaw 可以显示或隐藏模型推理:
|
||||
- 当模型产生推理内容时,它仍计入 token 使用量。
|
||||
- Telegram 支持将推理流式传输到草稿气泡中。
|
||||
|
||||
详情:[思考 + 推理指令](/tools/thinking)和 [Token 使用](/token-use)。
|
||||
详情:[思考 + 推理指令](/tools/thinking)和 [Token 使用](/reference/token-use)。
|
||||
|
||||
## 前缀、线程和回复
|
||||
|
||||
|
||||
@@ -185,7 +185,7 @@ openclaw models status
|
||||
输入
|
||||
|
||||
- OpenRouter `/models` 列表(筛选 `:free`)
|
||||
- 需要来自认证配置文件或 `OPENROUTER_API_KEY` 的 OpenRouter API 密钥(参见 [/environment](/environment))
|
||||
- 需要来自认证配置文件或 `OPENROUTER_API_KEY` 的 OpenRouter API 密钥(参见 [/environment](/help/environment))
|
||||
- 可选筛选器:`--max-age-days`、`--min-params`、`--provider`、`--max-candidates`
|
||||
- 探测控制:`--timeout`、`--concurrency`
|
||||
|
||||
|
||||
@@ -113,7 +113,7 @@ openclaw agents list --bindings
|
||||
注意事项:
|
||||
|
||||
- 私信访问控制是**每 WhatsApp 账户全局的**(配对/允许列表),而不是每智能体。
|
||||
- 对于共享群组,将群组绑定到一个智能体或使用 [广播群组](/broadcast-groups)。
|
||||
- 对于共享群组,将群组绑定到一个智能体或使用 [广播群组](/channels/broadcast-groups)。
|
||||
|
||||
## 路由规则(消息如何选择智能体)
|
||||
|
||||
@@ -369,4 +369,4 @@ openclaw agents list --bindings
|
||||
如果你需要每智能体边界,使用 `agents.list[].tools` 拒绝 `exec`。
|
||||
对于群组定向,使用 `agents.list[].groupChat.mentionPatterns` 使 @提及清晰地映射到目标智能体。
|
||||
|
||||
参见 [多智能体沙箱和工具](/multi-agent-sandbox-tools) 了解详细示例。
|
||||
参见 [多智能体沙箱和工具](/tools/multi-agent-sandbox-tools) 了解详细示例。
|
||||
|
||||
@@ -41,5 +41,5 @@ Telegram 允许列表现在不区分大小写地接受 `telegram:` 和 `tg:` 前
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [群聊](/concepts/groups)
|
||||
- [群聊](/channels/groups)
|
||||
- [Telegram 提供商](/channels/telegram)
|
||||
|
||||
@@ -294,7 +294,7 @@ OpenClaw 从父进程(shell、launchd/systemd、CI 等)读取环境变量。
|
||||
}
|
||||
```
|
||||
|
||||
参见 [/environment](/environment) 了解优先级和来源详情。
|
||||
参见 [/environment](/help/environment) 了解优先级和来源详情。
|
||||
|
||||
### `env.shellEnv`(可选)
|
||||
|
||||
@@ -789,7 +789,7 @@ OpenClaw 在以下位置存储**每个智能体的**认证配置文件(OAuth +
|
||||
- **只读**工具 + 工作区
|
||||
- **无文件系统访问**(仅消息/会话工具)
|
||||
|
||||
参见[多智能体沙箱与工具](/multi-agent-sandbox-tools)了解优先级和更多示例。
|
||||
参见[多智能体沙箱与工具](/tools/multi-agent-sandbox-tools)了解优先级和更多示例。
|
||||
|
||||
完全访问(无沙箱):
|
||||
|
||||
@@ -2780,7 +2780,7 @@ Z.AI 模型通过内置的 `zai` 提供商提供。在环境中设置 `ZAI_API_K
|
||||
### `plugins`(扩展)
|
||||
|
||||
控制插件发现、允许/拒绝和每插件配置。插件从 `~/.openclaw/extensions`、`<workspace>/.openclaw/extensions` 以及任何 `plugins.load.paths` 条目加载。**配置更改需要重启 Gateway 网关。**
|
||||
参见 [/plugin](/plugin) 了解详情。
|
||||
参见 [/plugin](/tools/plugin) 了解详情。
|
||||
|
||||
字段:
|
||||
|
||||
|
||||
@@ -137,7 +137,7 @@ x-i18n:
|
||||
- `session`:心跳运行的可选会话键。
|
||||
- `main`(默认):智能体主会话。
|
||||
- 显式会话键(从 `openclaw sessions --json` 或 [sessions CLI](/cli/sessions) 复制)。
|
||||
- 会话键格式:参见[会话](/concepts/session)和[群组](/concepts/groups)。
|
||||
- 会话键格式:参见[会话](/concepts/session)和[群组](/channels/groups)。
|
||||
- `target`:
|
||||
- `last`(默认):发送到最后使用的外部渠道。
|
||||
- 显式渠道:`whatsapp` / `telegram` / `discord` / `googlechat` / `slack` / `msteams` / `signal` / `imessage`。
|
||||
|
||||
@@ -163,7 +163,7 @@ Docker 安装和容器化 Gateway 网关在此:
|
||||
|
||||
每个智能体可以覆盖沙箱 + 工具:
|
||||
`agents.list[].sandbox` 和 `agents.list[].tools`(加上 `agents.list[].tools.sandbox.tools` 用于沙箱工具策略)。
|
||||
参见[多智能体沙箱与工具](/multi-agent-sandbox-tools)了解优先级。
|
||||
参见[多智能体沙箱与工具](/tools/multi-agent-sandbox-tools)了解优先级。
|
||||
|
||||
## 最小启用示例
|
||||
|
||||
@@ -184,5 +184,5 @@ Docker 安装和容器化 Gateway 网关在此:
|
||||
## 相关文档
|
||||
|
||||
- [沙箱配置](/gateway/configuration#agentsdefaults-sandbox)
|
||||
- [多智能体沙箱与工具](/multi-agent-sandbox-tools)
|
||||
- [多智能体沙箱与工具](/tools/multi-agent-sandbox-tools)
|
||||
- [安全](/gateway/security)
|
||||
|
||||
@@ -1,169 +0,0 @@
|
||||
---
|
||||
permalink: /security/formal-verification/
|
||||
summary: 针对 OpenClaw 最高风险路径的机器检查安全模型。
|
||||
title: 形式化验证(安全模型)
|
||||
x-i18n:
|
||||
generated_at: "2026-02-03T07:49:03Z"
|
||||
model: claude-opus-4-5
|
||||
provider: pi
|
||||
source_hash: 8dff6ea41a37fb6b870424e4e788015c3f8a6099075eece5dbf909883c045106
|
||||
source_path: gateway/security/formal-verification.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
# 形式化验证(安全模型)
|
||||
|
||||
本页跟踪 OpenClaw 的**形式化安全模型**(目前是 TLA+/TLC;根据需要会增加更多)。
|
||||
|
||||
> 注意:一些较旧的链接可能引用以前的项目名称。
|
||||
|
||||
**目标(北极星):** 在明确的假设下,提供机器检查的论证,证明 OpenClaw 执行其预期的安全策略(授权、会话隔离、工具限制和错误配置安全)。
|
||||
|
||||
**目前是什么:** 一个可执行的、攻击者驱动的**安全回归套件**:
|
||||
|
||||
- 每个声明都有一个在有限状态空间上运行的模型检查。
|
||||
- 许多声明有一个配对的**负面模型**,为现实的错误类别生成反例轨迹。
|
||||
|
||||
**目前还不是什么:** 证明"OpenClaw 在所有方面都是安全的"或完整的 TypeScript 实现是正确的。
|
||||
|
||||
## 模型存放位置
|
||||
|
||||
模型维护在单独的仓库中:[vignesh07/openclaw-formal-models](https://github.com/vignesh07/openclaw-formal-models)。
|
||||
|
||||
## 重要注意事项
|
||||
|
||||
- 这些是**模型**,不是完整的 TypeScript 实现。模型和代码之间可能存在偏差。
|
||||
- 结果受 TLC 探索的状态空间限制;"绿色"并不意味着超出建模假设和边界的安全性。
|
||||
- 一些声明依赖于明确的环境假设(例如,正确的部署、正确的配置输入)。
|
||||
|
||||
## 重现结果
|
||||
|
||||
目前,通过在本地克隆模型仓库并运行 TLC 来重现结果(见下文)。未来的迭代可能提供:
|
||||
|
||||
- 带有公开产物(反例轨迹、运行日志)的 CI 运行模型
|
||||
- 用于小型有界检查的托管"运行此模型"工作流
|
||||
|
||||
入门:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/vignesh07/openclaw-formal-models
|
||||
cd openclaw-formal-models
|
||||
|
||||
# 需要 Java 11+(TLC 在 JVM 上运行)。
|
||||
# 仓库附带一个固定版本的 `tla2tools.jar`(TLA+ 工具)并提供 `bin/tlc` + Make 目标。
|
||||
|
||||
make <target>
|
||||
```
|
||||
|
||||
### Gateway 网关暴露和开放 Gateway 网关错误配置
|
||||
|
||||
**声明:** 在没有认证的情况下绑定到 loopback 之外可能导致远程攻击 / 增加暴露;令牌/密码阻止未授权攻击者(根据模型假设)。
|
||||
|
||||
- 绿色运行:
|
||||
- `make gateway-exposure-v2`
|
||||
- `make gateway-exposure-v2-protected`
|
||||
- 红色(预期):
|
||||
- `make gateway-exposure-v2-negative`
|
||||
|
||||
另请参阅:模型仓库中的 `docs/gateway-exposure-matrix.md`。
|
||||
|
||||
### Nodes.run 管道(最高风险能力)
|
||||
|
||||
**声明:** `nodes.run` 需要 (a) 节点命令允许列表加上声明的命令,以及 (b) 配置时的实时批准;批准是令牌化的以防止重放(在模型中)。
|
||||
|
||||
- 绿色运行:
|
||||
- `make nodes-pipeline`
|
||||
- `make approvals-token`
|
||||
- 红色(预期):
|
||||
- `make nodes-pipeline-negative`
|
||||
- `make approvals-token-negative`
|
||||
|
||||
### 配对存储(私信限制)
|
||||
|
||||
**声明:** 配对请求遵守 TTL 和待处理请求上限。
|
||||
|
||||
- 绿色运行:
|
||||
- `make pairing`
|
||||
- `make pairing-cap`
|
||||
- 红色(预期):
|
||||
- `make pairing-negative`
|
||||
- `make pairing-cap-negative`
|
||||
|
||||
### 入站限制(提及 + 控制命令绕过)
|
||||
|
||||
**声明:** 在需要提及的群组上下文中,未授权的"控制命令"无法绕过提及限制。
|
||||
|
||||
- 绿色:
|
||||
- `make ingress-gating`
|
||||
- 红色(预期):
|
||||
- `make ingress-gating-negative`
|
||||
|
||||
### 路由/会话键隔离
|
||||
|
||||
**声明:** 来自不同对等方的私信不会合并到同一会话中,除非明确链接/配置。
|
||||
|
||||
- 绿色:
|
||||
- `make routing-isolation`
|
||||
- 红色(预期):
|
||||
- `make routing-isolation-negative`
|
||||
|
||||
## v1++:额外的有界模型(并发、重试、轨迹正确性)
|
||||
|
||||
这些是后续模型,围绕真实世界的故障模式(非原子更新、重试和消息扇出)提高保真度。
|
||||
|
||||
### 配对存储并发/幂等性
|
||||
|
||||
**声明:** 即使在交错执行下,配对存储也应强制执行 `MaxPending` 和幂等性(即"检查后写入"必须是原子/锁定的;刷新不应创建重复项)。
|
||||
|
||||
这意味着:
|
||||
|
||||
- 在并发请求下,你不能超过渠道的 `MaxPending`。
|
||||
- 对同一 `(channel, sender)` 的重复请求/刷新不应创建重复的活动待处理行。
|
||||
|
||||
- 绿色运行:
|
||||
- `make pairing-race`(原子/锁定上限检查)
|
||||
- `make pairing-idempotency`
|
||||
- `make pairing-refresh`
|
||||
- `make pairing-refresh-race`
|
||||
- 红色(预期):
|
||||
- `make pairing-race-negative`(非原子 begin/commit 上限竞争)
|
||||
- `make pairing-idempotency-negative`
|
||||
- `make pairing-refresh-negative`
|
||||
- `make pairing-refresh-race-negative`
|
||||
|
||||
### 入站轨迹关联/幂等性
|
||||
|
||||
**声明:** 摄取应在扇出时保留轨迹关联,并在提供商重试下保持幂等。
|
||||
|
||||
这意味着:
|
||||
|
||||
- 当一个外部事件变成多个内部消息时,每个部分保持相同的轨迹/事件标识。
|
||||
- 重试不会导致重复处理。
|
||||
- 如果缺少提供商事件 ID,去重会回退到安全键(例如轨迹 ID)以避免丢弃不同的事件。
|
||||
|
||||
- 绿色:
|
||||
- `make ingress-trace`
|
||||
- `make ingress-trace2`
|
||||
- `make ingress-idempotency`
|
||||
- `make ingress-dedupe-fallback`
|
||||
- 红色(预期):
|
||||
- `make ingress-trace-negative`
|
||||
- `make ingress-trace2-negative`
|
||||
- `make ingress-idempotency-negative`
|
||||
- `make ingress-dedupe-fallback-negative`
|
||||
|
||||
### 路由 dmScope 优先级 + identityLinks
|
||||
|
||||
**声明:** 路由必须默认保持私信会话隔离,仅在明确配置时合并会话(渠道优先级 + 身份链接)。
|
||||
|
||||
这意味着:
|
||||
|
||||
- 渠道特定的 dmScope 覆盖必须优先于全局默认值。
|
||||
- identityLinks 应仅在明确链接的组内合并,而不是跨不相关的对等方。
|
||||
|
||||
- 绿色:
|
||||
- `make routing-precedence`
|
||||
- `make routing-identitylinks`
|
||||
- 红色(预期):
|
||||
- `make routing-precedence-negative`
|
||||
- `make routing-identitylinks-negative`
|
||||
@@ -169,7 +169,7 @@ OpenClaw 的立场:
|
||||
- OpenClaw 使用 `npm pack` 然后在该目录中运行 `npm install --omit=dev`(npm 生命周期脚本可以在安装期间执行代码)。
|
||||
- 优先使用固定的精确版本(`@scope/pkg@1.2.3`),并在启用之前检查磁盘上解压的代码。
|
||||
|
||||
详情:[插件](/plugin)
|
||||
详情:[插件](/tools/plugin)
|
||||
|
||||
## 私信访问模型(配对/白名单/开放/禁用)
|
||||
|
||||
@@ -187,7 +187,7 @@ openclaw pairing list <channel>
|
||||
openclaw pairing approve <channel> <code>
|
||||
```
|
||||
|
||||
详情 + 磁盘上的文件:[配对](/start/pairing)
|
||||
详情 + 磁盘上的文件:[配对](/channels/pairing)
|
||||
|
||||
## 私信会话隔离(多用户模式)
|
||||
|
||||
@@ -214,7 +214,7 @@ OpenClaw 有两个独立的"谁可以触发我?"层:
|
||||
- `channels.discord.guilds` / `channels.slack.channels`:单平台白名单 + 提及默认值。
|
||||
- **安全说明:** 将 `dmPolicy="open"` 和 `groupPolicy="open"` 视为最后手段的设置。应该很少使用;除非你完全信任房间的每个成员,否则优先使用配对 + 白名单。
|
||||
|
||||
详情:[配置](/gateway/configuration)和[群组](/concepts/groups)
|
||||
详情:[配置](/gateway/configuration)和[群组](/channels/groups)
|
||||
|
||||
## 提示词注入(是什么,为什么重要)
|
||||
|
||||
@@ -584,7 +584,7 @@ Doctor 可以为你生成一个:`openclaw doctor --generate-gateway-token`。
|
||||
|
||||
## 单智能体访问配置(多智能体)
|
||||
|
||||
通过多智能体路由,每个智能体可以有自己的沙箱 + 工具策略:使用这个为每个智能体提供**完全访问**、**只读**或**无访问**权限。参见[多智能体沙箱和工具](/multi-agent-sandbox-tools)了解详情和优先级规则。
|
||||
通过多智能体路由,每个智能体可以有自己的沙箱 + 工具策略:使用这个为每个智能体提供**完全访问**、**只读**或**无访问**权限。参见[多智能体沙箱和工具](/tools/multi-agent-sandbox-tools)了解详情和优先级规则。
|
||||
|
||||
常见用例:
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ x-i18n:
|
||||
model: claude-opus-4-5
|
||||
provider: pi
|
||||
source_hash: 504c824bff4790006c8b73600daca66b919e049178e9711e6e65b6254731911a
|
||||
source_path: debugging.md
|
||||
source_path: help/debugging.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
@@ -10,7 +10,7 @@ x-i18n:
|
||||
model: claude-opus-4-5
|
||||
provider: pi
|
||||
source_hash: b49ae50e5d306612f89f93a86236188a4f2ec23f667e2388b043832be3ac1546
|
||||
source_path: environment.md
|
||||
source_path: help/environment.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
@@ -669,7 +669,7 @@ claude setup-token
|
||||
|
||||
### 支持 AWS Bedrock 吗
|
||||
|
||||
是的——通过 pi-ai 的 **Amazon Bedrock (Converse)** 提供商进行**手动配置**。你必须在 Gateway 网关主机上提供 AWS 凭据/区域,并在模型配置中添加 Bedrock 提供商条目。参阅 [Amazon Bedrock](/bedrock) 和[模型提供商](/providers/models)。如果你更喜欢托管密钥流程,在 Bedrock 前面使用兼容 OpenAI 的代理仍然是有效选项。
|
||||
是的——通过 pi-ai 的 **Amazon Bedrock (Converse)** 提供商进行**手动配置**。你必须在 Gateway 网关主机上提供 AWS 凭据/区域,并在模型配置中添加 Bedrock 提供商条目。参阅 [Amazon Bedrock](/providers/bedrock) 和[模型提供商](/providers/models)。如果你更喜欢托管密钥流程,在 Bedrock 前面使用兼容 OpenAI 的代理仍然是有效选项。
|
||||
|
||||
### Codex 认证如何工作
|
||||
|
||||
@@ -1094,7 +1094,7 @@ openclaw browser extension path
|
||||
|
||||
使用 `agents.defaults.sandbox.mode: "non-main"`,这样群组/频道会话(非主键)在 Docker 中运行,而主私信会话保持在主机上。然后通过 `tools.sandbox.tools` 限制沙箱会话中可用的工具。
|
||||
|
||||
设置指南 + 示例配置:[群组:个人私信 + 公开群组](/concepts/groups#pattern-personal-dms-public-groups-single-agent)
|
||||
设置指南 + 示例配置:[群组:个人私信 + 公开群组](/channels/groups#pattern-personal-dms-public-groups-single-agent)
|
||||
|
||||
关键配置参考:[Gateway 网关配置](/gateway/configuration#agentsdefaultssandbox)
|
||||
|
||||
@@ -1321,7 +1321,7 @@ Gateway 网关监视配置文件并支持热重载:
|
||||
- **子智能体:** 需要并行处理时从主智能体生成后台工作。
|
||||
- **TUI:** 连接到 Gateway 网关并切换智能体/会话。
|
||||
|
||||
文档:[节点](/nodes)、[远程访问](/gateway/remote)、[多智能体路由](/concepts/multi-agent)、[子智能体](/tools/subagents)、[TUI](/tui)。
|
||||
文档:[节点](/nodes)、[远程访问](/gateway/remote)、[多智能体路由](/concepts/multi-agent)、[子智能体](/tools/subagents)、[TUI](/web/tui)。
|
||||
|
||||
### OpenClaw 浏览器可以无头运行吗
|
||||
|
||||
@@ -1527,7 +1527,7 @@ OpenClaw 从父进程(shell、launchd/systemd、CI 等)读取环境变量,
|
||||
}
|
||||
```
|
||||
|
||||
参阅 [/environment](/environment) 了解优先级和来源详情。
|
||||
参阅 [/environment](/help/environment) 了解优先级和来源详情。
|
||||
|
||||
### 我通过服务启动了 Gateway 网关,但环境变量消失了,怎么办
|
||||
|
||||
@@ -1570,7 +1570,7 @@ openclaw models status
|
||||
```
|
||||
|
||||
Copilot 令牌从 `COPILOT_GITHUB_TOKEN` 读取(也支持 `GH_TOKEN` / `GITHUB_TOKEN`)。
|
||||
参阅 [/concepts/model-providers](/concepts/model-providers) 和 [/environment](/environment)。
|
||||
参阅 [/concepts/model-providers](/concepts/model-providers) 和 [/environment](/help/environment)。
|
||||
|
||||
## 会话与多聊天
|
||||
|
||||
@@ -1731,11 +1731,11 @@ openclaw directory groups list --channel whatsapp
|
||||
- 提及限制已开启(默认)。你必须 @提及机器人(或匹配 `mentionPatterns`)。
|
||||
- 你配置了 `channels.whatsapp.groups` 但没有 `"*"` 且该群组未加入允许列表。
|
||||
|
||||
参阅[群组](/concepts/groups)和[群组消息](/concepts/group-messages)。
|
||||
参阅[群组](/channels/groups)和[群组消息](/channels/group-messages)。
|
||||
|
||||
### 群组/线程与私聊共享上下文吗
|
||||
|
||||
直接聊天默认折叠到主会话。群组/频道有自己的会话键,Telegram 话题 / Discord 线程是独立的会话。参阅[群组](/concepts/groups)和[群组消息](/concepts/group-messages)。
|
||||
直接聊天默认折叠到主会话。群组/频道有自己的会话键,Telegram 话题 / Discord 线程是独立的会话。参阅[群组](/channels/groups)和[群组消息](/channels/group-messages)。
|
||||
|
||||
### 可以创建多少个工作区和智能体
|
||||
|
||||
@@ -2410,7 +2410,7 @@ openclaw logs --follow
|
||||
|
||||
在 TUI 中,使用 `/status` 查看当前状态。如果你期望在聊天渠道中收到回复,确保投递已启用(`/deliver on`)。
|
||||
|
||||
文档:[TUI](/tui)、[斜杠命令](/tools/slash-commands)。
|
||||
文档:[TUI](/web/tui)、[斜杠命令](/tools/slash-commands)。
|
||||
|
||||
### 如何完全停止然后启动 Gateway 网关如果你安装了服务:
|
||||
|
||||
@@ -2492,7 +2492,7 @@ openclaw message send --target +15555550123 --message "Here you go" --media /pat
|
||||
|
||||
从小处开始。只授予你实际需要的工具和账户的访问权限,以后需要时再扩展。
|
||||
|
||||
文档:[安全](/gateway/security)、[配对](/start/pairing)。
|
||||
文档:[安全](/gateway/security)、[配对](/channels/pairing)。
|
||||
|
||||
### 我能让它自主管理我的短信吗?这安全吗
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ x-i18n:
|
||||
model: claude-opus-4-5
|
||||
provider: pi
|
||||
source_hash: bfedc3c123c4a43b351f793e2137568786f90732723da5fd223c2a088bc59e43
|
||||
source_path: scripts.md
|
||||
source_path: help/scripts.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
summary: 如何提交高信号 PR
|
||||
title: 提交 PR
|
||||
---
|
||||
|
||||
# 提交 PR
|
||||
|
||||
该页面是英文文档的中文占位版本,完整内容请先参考英文版:[Submitting a PR](/help/submitting-a-pr)。
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
summary: 如何提交高信号 Issue
|
||||
title: 提交 Issue
|
||||
---
|
||||
|
||||
# 提交 Issue
|
||||
|
||||
该页面是英文文档的中文占位版本,完整内容请先参考英文版:[Submitting an Issue](/help/submitting-an-issue)。
|
||||
@@ -10,7 +10,7 @@ x-i18n:
|
||||
model: claude-opus-4-5
|
||||
provider: pi
|
||||
source_hash: 8c236673838731c49464622ac54bf0336acf787b857677c8c2d2aa52949c8ad5
|
||||
source_path: testing.md
|
||||
source_path: help/testing.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
@@ -69,4 +69,4 @@ openclaw hooks enable soul-evil
|
||||
|
||||
## 另请参阅
|
||||
|
||||
- [钩子](/hooks)
|
||||
- [钩子](/automation/hooks)
|
||||
|
||||
@@ -114,7 +114,7 @@ nmap -p- YOUR_SERVER_IP
|
||||
|
||||
Docker 用于**智能体沙箱**(隔离的工具执行),而不是用于运行 Gateway 网关本身。Gateway 网关仅绑定到 localhost,通过 Tailscale VPN 访问。
|
||||
|
||||
沙箱配置参见[多智能体沙箱与工具](/multi-agent-sandbox-tools)。
|
||||
沙箱配置参见[多智能体沙箱与工具](/tools/multi-agent-sandbox-tools)。
|
||||
|
||||
## 手动安装
|
||||
|
||||
@@ -212,4 +212,4 @@ openclaw channels login
|
||||
- [openclaw-ansible](https://github.com/openclaw/openclaw-ansible) — 完整部署指南
|
||||
- [Docker](/install/docker) — 容器化 Gateway 网关设置
|
||||
- [沙箱隔离](/gateway/sandboxing) — 智能体沙箱配置
|
||||
- [多智能体沙箱与工具](/multi-agent-sandbox-tools) — 每个智能体的隔离
|
||||
- [多智能体沙箱与工具](/tools/multi-agent-sandbox-tools) — 每个智能体的隔离
|
||||
|
||||
@@ -314,7 +314,7 @@ pnpm test:docker:qr
|
||||
- 只读工具 + 只读工作区(家庭/工作智能体)
|
||||
- 无文件系统/shell 工具(公共智能体)
|
||||
|
||||
参阅[多智能体沙箱与工具](/multi-agent-sandbox-tools)了解示例、优先级和故障排除。
|
||||
参阅[多智能体沙箱与工具](/tools/multi-agent-sandbox-tools)了解示例、优先级和故障排除。
|
||||
|
||||
### 默认行为
|
||||
|
||||
|
||||
@@ -1,85 +1,8 @@
|
||||
---
|
||||
read_when:
|
||||
- 你已安装 OpenClaw 但 `openclaw` 提示"command not found"
|
||||
- 你正在新机器上配置 Node.js/npm
|
||||
- npm install -g ... 因权限或 PATH 问题失败
|
||||
summary: Node.js + npm 安装完整性检查:版本、PATH 及全局安装
|
||||
title: Node.js + npm(PATH 安装完整性检查)
|
||||
x-i18n:
|
||||
generated_at: "2026-02-01T21:16:20Z"
|
||||
model: claude-opus-4-5
|
||||
provider: pi
|
||||
source_hash: 9f6d83be362e3e148ddf07d47e57c51679c22687263d3b5131cccbef2e37c598
|
||||
source_path: install/node.md
|
||||
workflow: 15
|
||||
summary: Node.js 安装与配置(OpenClaw 版本要求、安装方式与 PATH 排错)
|
||||
title: Node.js
|
||||
---
|
||||
|
||||
# Node.js + npm(PATH 安装完整性检查)
|
||||
# Node.js
|
||||
|
||||
OpenClaw 的运行时基线要求为 **Node 22+**。
|
||||
|
||||
如果你能运行 `npm install -g openclaw@latest`,但之后看到 `openclaw: command not found`,这几乎总是 **PATH** 问题:npm 存放全局二进制文件的目录不在你 shell 的 PATH 中。
|
||||
|
||||
## 快速诊断
|
||||
|
||||
运行:
|
||||
|
||||
```bash
|
||||
node -v
|
||||
npm -v
|
||||
npm prefix -g
|
||||
echo "$PATH"
|
||||
```
|
||||
|
||||
如果 `$(npm prefix -g)/bin`(macOS/Linux)或 `$(npm prefix -g)`(Windows)**未出现**在 `echo "$PATH"` 的输出中,你的 shell 就无法找到全局 npm 二进制文件(包括 `openclaw`)。
|
||||
|
||||
## 修复:将 npm 的全局 bin 目录添加到 PATH
|
||||
|
||||
1. 查找你的全局 npm 前缀:
|
||||
|
||||
```bash
|
||||
npm prefix -g
|
||||
```
|
||||
|
||||
2. 将全局 npm bin 目录添加到你的 shell 启动文件中:
|
||||
|
||||
- zsh:`~/.zshrc`
|
||||
- bash:`~/.bashrc`
|
||||
|
||||
示例(将路径替换为你的 `npm prefix -g` 输出):
|
||||
|
||||
```bash
|
||||
# macOS / Linux
|
||||
export PATH="/path/from/npm/prefix/bin:$PATH"
|
||||
```
|
||||
|
||||
然后打开一个**新终端**(或在 zsh 中运行 `rehash` / 在 bash 中运行 `hash -r`)。
|
||||
|
||||
在 Windows 上,将 `npm prefix -g` 的输出添加到你的 PATH 中。
|
||||
|
||||
## 修复:避免 `sudo npm install -g` / 权限错误(Linux)
|
||||
|
||||
如果 `npm install -g ...` 因 `EACCES` 失败,请将 npm 的全局前缀切换到用户可写的目录:
|
||||
|
||||
```bash
|
||||
mkdir -p "$HOME/.npm-global"
|
||||
npm config set prefix "$HOME/.npm-global"
|
||||
export PATH="$HOME/.npm-global/bin:$PATH"
|
||||
```
|
||||
|
||||
将 `export PATH=...` 这一行持久化到你的 shell 启动文件中。
|
||||
|
||||
## 推荐的 Node 安装方式
|
||||
|
||||
如果 Node/npm 的安装方式满足以下条件,你将遇到最少的问题:
|
||||
|
||||
- 保持 Node 更新(22+)
|
||||
- 使全局 npm bin 目录稳定且在新 shell 中位于 PATH 中
|
||||
|
||||
常见选择:
|
||||
|
||||
- macOS:Homebrew(`brew install node`)或版本管理器
|
||||
- Linux:你偏好的版本管理器,或提供 Node 22+ 的发行版支持的安装方式
|
||||
- Windows:官方 Node 安装程序、`winget` 或 Windows Node 版本管理器
|
||||
|
||||
如果你使用版本管理器(nvm/fnm/asdf 等),请确保它在你日常使用的 shell(zsh 或 bash)中已初始化,这样它设置的 PATH 在你运行安装程序时才会生效。
|
||||
该页面是英文文档的中文占位版本,完整内容请先参考英文版:[Node.js](/install/node)。
|
||||
|
||||
@@ -27,7 +27,7 @@ x-i18n:
|
||||
|
||||
## 配对 + 身份
|
||||
|
||||
- [配对概述(私信 + 节点)](/start/pairing)
|
||||
- [配对概述(私信 + 节点)](/channels/pairing)
|
||||
- [Gateway 网关拥有的节点配对](/gateway/pairing)
|
||||
- [Devices CLI(配对 + token 轮换)](/cli/devices)
|
||||
- [Pairing CLI(私信审批)](/cli/pairing)
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
summary: 节点故障排查:排查配对、前台限制、权限与工具调用失败
|
||||
title: 节点故障排查
|
||||
---
|
||||
|
||||
# 节点故障排查
|
||||
|
||||
该页面是英文文档的中文占位版本,完整内容请先参考英文版:[Node Troubleshooting](/nodes/troubleshooting)。
|
||||
@@ -17,7 +17,7 @@ x-i18n:
|
||||
|
||||
每个插件都**必须**在**插件根目录**下提供一个 `openclaw.plugin.json` 文件。OpenClaw 使用此清单来**在不执行插件代码的情况下**验证配置。缺失或无效的清单将被视为插件错误,并阻止配置验证。
|
||||
|
||||
参阅完整的插件系统指南:[插件](/plugin)。
|
||||
参阅完整的插件系统指南:[插件](/tools/plugin)。
|
||||
|
||||
## 必填字段
|
||||
|
||||
|
||||
+1
-1
@@ -38,7 +38,7 @@ openclaw plugins enable open-prose
|
||||
|
||||
开发/本地检出:`openclaw plugins install ./extensions/open-prose`
|
||||
|
||||
相关文档:[插件](/plugin)、[插件清单](/plugins/manifest)、[Skills](/tools/skills)。
|
||||
相关文档:[插件](/tools/plugin)、[插件清单](/plugins/manifest)、[Skills](/tools/skills)。
|
||||
|
||||
## 斜杠命令
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ x-i18n:
|
||||
model: claude-opus-4-5
|
||||
provider: pi
|
||||
source_hash: 318f1048451a1910b70522e2f7f9dfc87084de26d9e3938a29d372eed32244a8
|
||||
source_path: bedrock.md
|
||||
source_path: providers/bedrock.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
@@ -48,7 +48,7 @@ Venice 是我们推荐的 Venice AI 设置,用于隐私优先的推理,并
|
||||
- [Vercel AI Gateway](/providers/vercel-ai-gateway)
|
||||
- [Moonshot AI(Kimi + Kimi Coding)](/providers/moonshot)
|
||||
- [OpenCode Zen](/providers/opencode)
|
||||
- [Amazon Bedrock](/bedrock)
|
||||
- [Amazon Bedrock](/providers/bedrock)
|
||||
- [Z.AI](/providers/zai)
|
||||
- [Xiaomi](/providers/xiaomi)
|
||||
- [GLM 模型](/providers/glm)
|
||||
|
||||
@@ -50,6 +50,6 @@ Venice 是我们推荐的 Venice AI 设置,用于隐私优先的推理,并
|
||||
- [GLM 模型](/providers/glm)
|
||||
- [MiniMax](/providers/minimax)
|
||||
- [Venice(Venice AI)](/providers/venice)
|
||||
- [Amazon Bedrock](/bedrock)
|
||||
- [Amazon Bedrock](/providers/bedrock)
|
||||
|
||||
有关完整的提供商目录(xAI、Groq、Mistral 等)和高级配置,请参阅[模型提供商](/concepts/model-providers)。
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
summary: 使用千帆统一 API 在 OpenClaw 中接入多种模型
|
||||
title: 千帆(Qianfan)
|
||||
---
|
||||
|
||||
# 千帆(Qianfan)
|
||||
|
||||
该页面是英文文档的中文占位版本,完整内容请先参考英文版:[Qianfan](/providers/qianfan)。
|
||||
@@ -218,4 +218,4 @@ export type PluginRuntime = {
|
||||
- 新连接器模板仅依赖 SDK + 运行时。
|
||||
- 外部插件可以在无需访问核心源码的情况下进行开发和更新。
|
||||
|
||||
相关文档:[插件](/plugin)、[渠道](/channels/index)、[配置](/gateway/configuration)。
|
||||
相关文档:[插件](/tools/plugin)、[渠道](/channels/index)、[配置](/gateway/configuration)。
|
||||
|
||||
@@ -34,7 +34,7 @@ x-i18n:
|
||||
|
||||
- `openclaw status --usage` 和 `openclaw channels list` 显示提供商**用量窗口**(配额快照,非每条消息的费用)。
|
||||
|
||||
详情和示例请参阅 [Token 用量与费用](/token-use)。
|
||||
详情和示例请参阅 [Token 用量与费用](/reference/token-use)。
|
||||
|
||||
## 密钥的发现方式
|
||||
|
||||
@@ -51,7 +51,7 @@ OpenClaw 可以从以下来源获取凭据:
|
||||
|
||||
每次回复或工具调用都使用**当前模型提供商**(OpenAI、Anthropic 等)。这是用量和费用的主要来源。
|
||||
|
||||
定价配置请参阅[模型](/providers/models),显示方式请参阅 [Token 用量与费用](/token-use)。
|
||||
定价配置请参阅[模型](/providers/models),显示方式请参阅 [Token 用量与费用](/reference/token-use)。
|
||||
|
||||
### 2)媒体理解(音频/图像/视频)
|
||||
|
||||
|
||||
@@ -161,7 +161,7 @@ OpenClaw 有意**不**"修复"记录;Gateway 网关使用 `SessionManager` 来
|
||||
- 上下文窗口来自模型目录(可以通过配置覆盖)。
|
||||
- 存储中的 `contextTokens` 是运行时估计/报告值;不要将其视为严格保证。
|
||||
|
||||
更多信息,参见 [/token-use](/token-use)。
|
||||
更多信息,参见 [/token-use](/reference/token-use)。
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ x-i18n:
|
||||
|
||||
# 测试
|
||||
|
||||
- 完整测试套件(测试集、实时测试、Docker):[测试](/testing)
|
||||
- 完整测试套件(测试集、实时测试、Docker):[测试](/help/testing)
|
||||
|
||||
- `pnpm test:force`:终止任何占用默认控制端口的遗留 Gateway 网关进程,然后使用隔离的 Gateway 网关端口运行完整的 Vitest 套件,这样服务器测试不会与正在运行的实例冲突。当之前的 Gateway 网关运行占用了端口 18789 时使用此命令。
|
||||
- `pnpm test:coverage`:使用 V8 覆盖率运行 Vitest。全局阈值为 70% 的行/分支/函数/语句覆盖率。覆盖率排除了集成密集型入口点(CLI 连接、gateway/telegram 桥接、webchat 静态服务器),以保持目标集中在可单元测试的逻辑上。
|
||||
|
||||
@@ -9,7 +9,7 @@ x-i18n:
|
||||
model: claude-opus-4-5
|
||||
provider: pi
|
||||
source_hash: aee417119851db9e36890487517ed9602d214849e412127e7f534ebec5c9e105
|
||||
source_path: token-use.md
|
||||
source_path: reference/token-use.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
---
|
||||
summary: Onboarding 向导参考:完整步骤、参数与配置字段
|
||||
title: 向导参考
|
||||
sidebarTitle: 向导参考
|
||||
---
|
||||
|
||||
# 向导参考
|
||||
|
||||
该页面是英文文档的中文占位版本,完整内容请先参考英文版:[Onboarding Wizard Reference](/reference/wizard)。
|
||||
@@ -0,0 +1,9 @@
|
||||
---
|
||||
summary: 智能体引导流程:首次运行时如何初始化工作区与身份文件
|
||||
title: 智能体引导
|
||||
sidebarTitle: 引导
|
||||
---
|
||||
|
||||
# 智能体引导
|
||||
|
||||
该页面是英文文档的中文占位版本,完整内容请先参考英文版:[Agent Bootstrapping](/start/bootstrapping)。
|
||||
@@ -25,7 +25,7 @@ x-i18n:
|
||||
- [斜杠命令](/tools/slash-commands)
|
||||
- [多智能体路由](/concepts/multi-agent)
|
||||
- [更新与回滚](/install/updating)
|
||||
- [配对(私信和节点)](/start/pairing)
|
||||
- [配对(私信和节点)](/channels/pairing)
|
||||
- [Nix 模式](/install/nix)
|
||||
- [OpenClaw 助手设置](/start/openclaw)
|
||||
- [Skills](/tools/skills)
|
||||
@@ -47,8 +47,8 @@ x-i18n:
|
||||
- [Mattermost(插件)](/channels/mattermost)
|
||||
- [BlueBubbles (iMessage)](/channels/bluebubbles)
|
||||
- [iMessage(旧版)](/channels/imessage)
|
||||
- [群组](/concepts/groups)
|
||||
- [WhatsApp 群消息](/concepts/group-messages)
|
||||
- [群组](/channels/groups)
|
||||
- [WhatsApp 群消息](/channels/group-messages)
|
||||
- [媒体图片](/nodes/images)
|
||||
- [媒体音频](/nodes/audio)
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ x-i18n:
|
||||
- 工作区引导 + Skills
|
||||
- 可选的后台服务
|
||||
|
||||
如果你想要更深入的参考页面,跳转到:[向导](/start/wizard)、[设置](/start/setup)、[配对](/start/pairing)、[安全](/gateway/security)。
|
||||
如果你想要更深入的参考页面,跳转到:[向导](/start/wizard)、[设置](/start/setup)、[配对](/channels/pairing)、[安全](/gateway/security)。
|
||||
|
||||
沙箱注意事项:`agents.defaults.sandbox.mode: "non-main"` 使用 `session.mainKey`(默认 `"main"`),因此群组/渠道会话会被沙箱隔离。如果你想要主智能体始终在主机上运行,设置显式的每智能体覆盖:
|
||||
|
||||
@@ -162,7 +162,7 @@ openclaw pairing list whatsapp
|
||||
openclaw pairing approve whatsapp <code>
|
||||
```
|
||||
|
||||
配对文档:[配对](/start/pairing)
|
||||
配对文档:[配对](/channels/pairing)
|
||||
|
||||
## 从源代码(开发)
|
||||
|
||||
|
||||
@@ -64,9 +64,9 @@ x-i18n:
|
||||
- [在线状态](/concepts/presence)
|
||||
- [设备发现 + 传输协议](/gateway/discovery)
|
||||
- [Bonjour](/gateway/bonjour)
|
||||
- [渠道路由](/concepts/channel-routing)
|
||||
- [群组](/concepts/groups)
|
||||
- [群组消息](/concepts/group-messages)
|
||||
- [渠道路由](/channels/channel-routing)
|
||||
- [群组](/channels/groups)
|
||||
- [群组消息](/channels/group-messages)
|
||||
- [模型故障转移](/concepts/model-failover)
|
||||
- [OAuth](/concepts/oauth)
|
||||
|
||||
@@ -121,7 +121,7 @@ x-i18n:
|
||||
- [模型](/concepts/models)
|
||||
- [子智能体](/tools/subagents)
|
||||
- [Agent send CLI](/tools/agent-send)
|
||||
- [终端界面](/tui)
|
||||
- [终端界面](/web/tui)
|
||||
- [浏览器控制](/tools/browser)
|
||||
- [浏览器(Linux 故障排除)](/tools/browser-linux-troubleshooting)
|
||||
- [轮询](/automation/poll)
|
||||
|
||||
@@ -173,7 +173,7 @@ OpenClaw 为 browser、canvas、nodes 和 cron 暴露**一流的智能体工具*
|
||||
## 插件 + 工具
|
||||
|
||||
插件可以在核心集之外注册**额外的工具**(和 CLI 命令)。
|
||||
参见[插件](/plugin)了解安装 + 配置,以及 [Skills](/tools/skills) 了解
|
||||
参见[插件](/tools/plugin)了解安装 + 配置,以及 [Skills](/tools/skills) 了解
|
||||
工具使用指导如何被注入到提示中。一些插件随工具一起提供自己的 Skills
|
||||
(例如,voice-call 插件)。
|
||||
|
||||
|
||||
@@ -338,7 +338,7 @@ OpenProse 与 Lobster 配合良好:使用 `/prose` 编排多智能体准备,
|
||||
|
||||
## 了解更多
|
||||
|
||||
- [插件](/plugin)
|
||||
- [插件](/tools/plugin)
|
||||
- [插件工具开发](/plugins/agent-tools)
|
||||
|
||||
## 案例研究:社区工作流
|
||||
|
||||
+1
-1
@@ -8,7 +8,7 @@ x-i18n:
|
||||
model: claude-opus-4-5
|
||||
provider: pi
|
||||
source_hash: f602cb6192b84b404cd7b6336562888a239d0fe79514edd51bd73c5b090131ef
|
||||
source_path: multi-agent-sandbox-tools.md
|
||||
source_path: tools/multi-agent-sandbox-tools.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
@@ -9,7 +9,7 @@ x-i18n:
|
||||
model: claude-opus-4-5
|
||||
provider: pi
|
||||
source_hash: b36ca6b90ca03eaae25c00f9b12f2717fcd17ac540ba616ee03b398b234c2308
|
||||
source_path: plugin.md
|
||||
source_path: tools/plugin.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
@@ -43,7 +43,7 @@ Skills 从**三个**位置加载:
|
||||
|
||||
## 插件 + Skills
|
||||
|
||||
插件可以通过在 `openclaw.plugin.json` 中列出 `skills` 目录(相对于插件根目录的路径)来发布自己的 Skills。插件 Skills 在插件启用时加载,并参与正常的 Skills 优先级规则。你可以通过插件配置条目上的 `metadata.openclaw.requires.config` 对它们进行门控。参见[插件](/plugin)了解发现/配置,以及[工具](/tools)了解这些 Skills 所教授的工具接口。
|
||||
插件可以通过在 `openclaw.plugin.json` 中列出 `skills` 目录(相对于插件根目录的路径)来发布自己的 Skills。插件 Skills 在插件启用时加载,并参与正常的 Skills 优先级规则。你可以通过插件配置条目上的 `metadata.openclaw.requires.config` 对它们进行门控。参见[插件](/tools/plugin)了解发现/配置,以及[工具](/tools)了解这些 Skills 所教授的工具接口。
|
||||
|
||||
## ClawHub(安装 + 同步)
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ x-i18n:
|
||||
model: claude-opus-4-5
|
||||
provider: pi
|
||||
source_hash: 4bf5b0037bbb3a166289f2f0a9399489637d4cf26335ae3577af9ea83eee747e
|
||||
source_path: tui.md
|
||||
source_path: web/tui.md
|
||||
workflow: 15
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user