@gguf/claw 2026.2.1 → 2026.2.2

package/docs/zh-CN/tools/exec-approvals.md

@@ -0,0 +1,233 @@
+---
+read_when:
+  - 配置执行审批或允许列表
+  - 在 macOS 应用中实现执行审批用户体验
+  - 审查沙箱逃逸提示及其影响
+summary: 执行审批、允许列表和沙箱逃逸提示
+title: 执行审批
+x-i18n:
+  generated_at: "2026-02-01T21:42:40Z"
+  model: claude-opus-4-5
+  provider: pi
+  source_hash: ed17aab60b1f9c797ea8e9143d39d3a500c7b8cad4ea4b7903fedbf799339d28
+  source_path: tools/exec-approvals.md
+  workflow: 15
+---
+
+# 执行审批
+
+执行审批是**伴侣应用 / 节点主机的安全护栏**，用于允许沙箱隔离的智能体在真实主机（`gateway` 或 `node`）上运行命令。可以将其理解为一种安全联锁机制：只有当策略 + 允许列表 +（可选的）用户审批全部通过时，命令才会被允许执行。
+执行审批是在工具策略和提权网关**之上**的额外检查（除非提权设置为 `full`，此时会跳过审批）。
+生效策略取 `tools.exec.*` 和审批默认值中**更严格**的一个；如果审批字段被省略，则使用 `tools.exec` 的值。
+
+如果伴侣应用 UI **不可用**，任何需要提示的请求将由 **ask 回退策略**（默认：deny）来决定。
+
+## 适用范围
+
+执行审批在执行主机上本地强制执行：
+
+- **Gateway网关主机** → Gateway网关机器上的 `openclaw` 进程
+- **节点主机** → 节点运行器（macOS 伴侣应用或无头节点主机）
+
+macOS 拆分：
+
+- **节点主机服务**通过本地 IPC 将 `system.run` 转发至 **macOS 应用**。
+- **macOS 应用**强制执行审批并在 UI 上下文中执行命令。
+
+## 设置与存储
+
+审批配置存储在执行主机上的本地 JSON 文件中：
+
+`~/.openclaw/exec-approvals.json`
+
+示例结构：
+
+```json
+{
+  "version": 1,
+  "socket": {
+    "path": "~/.openclaw/exec-approvals.sock",
+    "token": "base64url-token"
+  },
+  "defaults": {
+    "security": "deny",
+    "ask": "on-miss",
+    "askFallback": "deny",
+    "autoAllowSkills": false
+  },
+  "agents": {
+    "main": {
+      "security": "allowlist",
+      "ask": "on-miss",
+      "askFallback": "deny",
+      "autoAllowSkills": true,
+      "allowlist": [
+        {
+          "id": "B0C8C0B3-2C2D-4F8A-9A3C-5A4B3C2D1E0F",
+          "pattern": "~/Projects/**/bin/rg",
+          "lastUsedAt": 1737150000000,
+          "lastUsedCommand": "rg -n TODO",
+          "lastResolvedPath": "/Users/user/Projects/.../bin/rg"
+        }
+      ]
+    }
+  }
+}
+```
+
+## 策略选项
+
+### 安全级别（`exec.security`）
+
+- **deny**：阻止所有主机执行请求。
+- **allowlist**：仅允许在允许列表中的命令。
+- **full**：允许所有命令（等同于提权模式）。
+
+### 询问（`exec.ask`）
+
+- **off**：从不提示。
+- **on-miss**：仅在允许列表未匹配时提示。
+- **always**：每次命令都提示。
+
+### 询问回退（`askFallback`）
+
+如果需要提示但无法连接到 UI，则由回退策略决定：
+
+- **deny**：阻止。
+- **allowlist**：仅在允许列表匹配时放行。
+- **full**：放行。
+
+## 允许列表（按智能体）
+
+允许列表是**按智能体**配置的。如果存在多个智能体，可以在 macOS 应用中切换要编辑的智能体。匹配模式为**不区分大小写的 glob 匹配**。
+模式应解析为**二进制路径**（仅包含基础名的条目会被忽略）。
+旧版 `agents.default` 条目在加载时会被迁移到 `agents.main`。
+
+示例：
+
+- `~/Projects/**/bin/bird`
+- `~/.local/bin/*`
+- `/opt/homebrew/bin/rg`
+
+每个允许列表条目跟踪以下信息：
+
+- **id** 用于 UI 标识的稳定 UUID（可选）
+- **最近使用**时间戳
+- **最近使用的命令**
+- **最近解析的路径**
+
+## 自动允许 Skills CLI
+
+启用**自动允许 Skills CLI** 后，已知 Skills 引用的可执行文件在节点上（macOS 节点或无头节点主机）会被视为已列入允许列表。此功能通过 Gateway网关 RPC 的 `skills.bins` 获取 Skills 二进制列表。如果需要严格的手动允许列表，请禁用此选项。
+
+## 安全二进制（仅限标准输入）
+
+`tools.exec.safeBins` 定义了一小组**仅限标准输入**的二进制文件（例如 `jq`），它们可以在允许列表模式下运行，**无需**显式添加到允许列表中。安全二进制会拒绝位置文件参数和类路径标记，因此只能操作传入的数据流。
+Shell 链式调用和重定向在允许列表模式下不会被自动允许。
+
+当每个顶层段都满足允许列表（包括安全二进制或 Skills 自动允许）时，Shell 链式调用（`&&`、`||`、`;`）是被允许的。重定向在允许列表模式下仍不受支持。
+
+默认安全二进制：`jq`、`grep`、`cut`、`sort`、`uniq`、`head`、`tail`、`tr`、`wc`。
+
+## 控制 UI 编辑
+
+使用**控制 UI → 节点 → 执行审批**卡片来编辑默认值、按智能体的覆盖配置和允许列表。选择一个范围（默认值或某个智能体），调整策略，添加/删除允许列表模式，然后点击**保存**。UI 会显示每个模式的**最近使用**元数据，方便你保持列表整洁。
+
+目标选择器可选择 **Gateway网关**（本地审批）或**节点**。节点必须广播 `system.execApprovals.get/set`（macOS 应用或无头节点主机）。
+如果某个节点尚未广播执行审批功能，请直接编辑其本地的 `~/.openclaw/exec-approvals.json` 文件。
+
+CLI：`openclaw approvals` 支持 Gateway网关或节点编辑（参见 [审批 CLI](/cli/approvals)）。
+
+## 审批流程
+
+当需要提示时，Gateway网关向操作员客户端广播 `exec.approval.requested`。
+控制 UI 和 macOS 应用通过 `exec.approval.resolve` 进行处理，然后 Gateway网关将已批准的请求转发至节点主机。
+
+当需要审批时，执行工具会立即返回一个审批 ID。使用该 ID 来关联后续的系统事件（`Exec finished` / `Exec denied`）。如果在超时前未收到决定，该请求将被视为审批超时并以拒绝原因呈现。
+
+确认对话框包含：
+
+- 命令 + 参数
+- 工作目录
+- 智能体 ID
+- 解析后的可执行文件路径
+- 主机 + 策略元数据
+
+操作：
+
+- **允许一次** → 立即运行
+- **始终允许** → 添加到允许列表并运行
+- **拒绝** → 阻止
+
+## 审批转发至聊天渠道
+
+你可以将执行审批提示转发到任何聊天渠道（包括插件渠道），并通过 `/approve` 进行审批。此功能使用常规的出站投递管道。
+
+配置：
+
+```json5
+{
+  approvals: {
+    exec: {
+      enabled: true,
+      mode: "session", // "session" | "targets" | "both"
+      agentFilter: ["main"],
+      sessionFilter: ["discord"], // 子串或正则表达式
+      targets: [
+        { channel: "slack", to: "U12345678" },
+        { channel: "telegram", to: "123456789" },
+      ],
+    },
+  },
+}
+```
+
+在聊天中回复：
+
+```
+/approve <id> allow-once
+/approve <id> allow-always
+/approve <id> deny
+```
+
+### macOS IPC 流程
+
+```
+Gateway网关 -> Node Service (WS)
+                 |  IPC (UDS + token + HMAC + TTL)
+                 v
+             Mac App (UI + approvals + system.run)
+```
+
+安全说明：
+
+- Unix 套接字模式 `0600`，令牌存储在 `exec-approvals.json` 中。
+- 同 UID 对端检查。
+- 质询/响应（nonce + HMAC 令牌 + 请求哈希）+ 短 TTL。
+
+## 系统事件
+
+执行生命周期以系统消息形式呈现：
+
+- `Exec running`（仅当命令超过运行通知阈值时）
+- `Exec finished`
+- `Exec denied`
+
+这些消息在节点报告事件后发布到智能体的会话中。
+Gateway网关主机执行审批在命令完成时（以及可选地在运行时间超过阈值时）发出相同的生命周期事件。
+经过审批网关的执行会复用审批 ID 作为这些消息中的 `runId`，便于关联。
+
+## 影响
+
+- **full** 权限很大；尽可能使用允许列表。
+- **ask** 让你保持知情，同时仍允许快速审批。
+- 按智能体的允许列表可防止一个智能体的审批泄漏到其他智能体。
+- 审批仅适用于来自**授权发送者**的主机执行请求。未授权的发送者无法发出 `/exec`。
+- `/exec security=full` 是面向授权操作员的会话级便捷功能，设计上会跳过审批。
+  要彻底阻止主机执行，请将审批安全级别设为 `deny`，或通过工具策略拒绝 `exec` 工具。
+
+相关内容：
+
+- [执行工具](/tools/exec)
+- [提权模式](/tools/elevated)
+- [Skills](/tools/skills)

package/docs/zh-CN/tools/exec.md

@@ -0,0 +1,168 @@
+---
+read_when:
+  - 使用或修改 exec 工具时
+  - 调试标准输入或 TTY 行为时
+summary: Exec 工具用法、标准输入模式与 TTY 支持
+title: Exec 工具
+x-i18n:
+  generated_at: "2026-02-01T21:42:35Z"
+  model: claude-opus-4-5
+  provider: pi
+  source_hash: 0d515b6039b43f7923b8cc6cd63717e3d029128e523b06c78003ca8077c20a21
+  source_path: tools/exec.md
+  workflow: 15
+---
+
+# Exec 工具
+
+在工作区中运行 shell 命令。通过 `process` 支持前台和后台执行。
+如果 `process` 被禁用，`exec` 将同步运行并忽略 `yieldMs`/`background`。
+后台会话按智能体隔离；`process` 只能查看同一智能体的会话。
+
+## 参数
+
+- `command`（必填）
+- `workdir`（默认为当前工作目录）
+- `env`（键/值覆盖）
+- `yieldMs`（默认 10000）：延迟后自动转为后台运行
+- `background`（布尔值）：立即转为后台运行
+- `timeout`（秒，默认 1800）：超时后终止
+- `pty`（布尔值）：在可用时使用伪终端运行（仅 TTY 的 CLI、编程智能体、终端 UI）
+- `host`（`sandbox | gateway | node`）：执行位置
+- `security`（`deny | allowlist | full`）：`gateway`/`node` 的执行策略模式
+- `ask`（`off | on-miss | always`）：`gateway`/`node` 的审批提示
+- `node`（字符串）：`host=node` 时的节点 ID/名称
+- `elevated`（布尔值）：请求提权模式（gateway 主机）；仅当提权解析为 `full` 时才强制 `security=full`
+
+说明：
+
+- `host` 默认为 `sandbox`。
+- 当沙箱关闭时，`elevated` 被忽略（exec 已直接在主机上运行）。
+- `gateway`/`node` 的审批由 `~/.openclaw/exec-approvals.json` 控制。
+- `node` 需要已配对的节点（伴侣应用或无头节点主机）。
+- 如果有多个节点可用，请设置 `exec.node` 或 `tools.exec.node` 来选择一个。
+- 在非 Windows 主机上，exec 在设置了 `SHELL` 时使用该 shell；如果 `SHELL` 是 `fish`，它会优先从 `PATH` 中选择 `bash`（或 `sh`）以避免 fish 不兼容的脚本，如果两者都不存在则回退到 `SHELL`。
+- 重要：沙箱**默认关闭**。如果沙箱关闭，`host=sandbox` 将直接在 Gateway网关主机上运行（无容器）且**不需要审批**。要启用审批，请使用 `host=gateway` 并配置 exec 审批（或启用沙箱）。
+
+## 配置
+
+- `tools.exec.notifyOnExit`（默认：true）：为 true 时，后台 exec 会话在退出时会排入系统事件并请求心跳。
+- `tools.exec.approvalRunningNoticeMs`（默认：10000）：当需要审批的 exec 运行超过此时间时，发出一条"运行中"通知（设为 0 禁用）。
+- `tools.exec.host`（默认：`sandbox`）
+- `tools.exec.security`（默认：sandbox 为 `deny`，未设置时 gateway + node 为 `allowlist`）
+- `tools.exec.ask`（默认：`on-miss`）
+- `tools.exec.node`（默认：未设置）
+- `tools.exec.pathPrepend`：exec 运行时要添加到 `PATH` 前面的目录列表。
+- `tools.exec.safeBins`：仅通过标准输入的安全二进制文件，无需显式添加到允许列表即可运行。
+
+示例：
+
+```json5
+{
+  tools: {
+    exec: {
+      pathPrepend: ["~/bin", "/opt/oss/bin"],
+    },
+  },
+}
+```
+
+### PATH 处理
+
+- `host=gateway`：将你的登录 shell `PATH` 合并到 exec 环境中（除非 exec 调用已设置 `env.PATH`）。守护进程本身仍使用最小 `PATH` 运行：
+  - macOS：`/opt/homebrew/bin`、`/usr/local/bin`、`/usr/bin`、`/bin`
+  - Linux：`/usr/local/bin`、`/usr/bin`、`/bin`
+- `host=sandbox`：在容器内运行 `sh -lc`（登录 shell），因此 `/etc/profile` 可能会重置 `PATH`。OpenClaw 在 profile 加载后通过内部环境变量添加 `env.PATH`（无 shell 插值）；`tools.exec.pathPrepend` 在此同样适用。
+- `host=node`：仅发送你传递的 env 覆盖到节点。`tools.exec.pathPrepend` 仅在 exec 调用已设置 `env.PATH` 时适用。无头节点主机仅在 `PATH` 为节点主机 PATH 前缀时接受 `PATH` 覆盖（不支持替换）。macOS 节点完全忽略 `PATH` 覆盖。
+
+按智能体绑定节点（在配置中使用智能体列表索引）：
+
+```bash
+openclaw config get agents.list
+openclaw config set agents.list[0].tools.exec.node "node-id-or-name"
+```
+
+控制界面：节点选项卡包含一个"Exec 节点绑定"面板，用于相同的设置。
+
+## 会话覆盖（`/exec`）
+
+使用 `/exec` 设置 `host`、`security`、`ask` 和 `node` 的**按会话**默认值。
+不带参数发送 `/exec` 可查看当前值。
+
+示例：
+
+```
+/exec host=gateway security=allowlist ask=on-miss node=mac-1
+```
+
+## 授权模型
+
+`/exec` 仅对**已授权的发送者**生效（渠道允许列表/配对加 `commands.useAccessGroups`）。
+它仅更新**会话状态**，不会写入配置。要彻底禁用 exec，请通过工具策略拒绝它（`tools.deny: ["exec"]` 或按智能体设置）。除非你显式设置 `security=full` 和 `ask=off`，否则主机审批仍然适用。
+
+## Exec 审批（伴侣应用 / 节点主机）
+
+沙箱隔离的智能体可以要求在 `exec` 于 Gateway网关或节点主机上运行前进行逐次审批。
+请参阅 [Exec 审批](/tools/exec-approvals) 了解策略、允许列表和 UI 流程。
+
+当需要审批时，exec 工具会立即返回 `status: "approval-pending"` 和一个审批 ID。一旦被批准（或拒绝/超时），Gateway网关会发出系统事件（`Exec finished` / `Exec denied`）。如果命令在 `tools.exec.approvalRunningNoticeMs` 之后仍在运行，会发出一条 `Exec running` 通知。
+
+## 允许列表与安全二进制文件
+
+允许列表执行仅匹配**已解析的二进制文件路径**（不匹配基本名称）。当 `security=allowlist` 时，shell 命令仅在每个管道段都在允许列表中或属于安全二进制文件时才会自动放行。在允许列表模式下，链式操作（`;`、`&&`、`||`）和重定向会被拒绝。
+
+## 示例
+
+前台：
+
+```json
+{ "tool": "exec", "command": "ls -la" }
+```
+
+后台 + 轮询：
+
+```json
+{"tool":"exec","command":"npm run build","yieldMs":1000}
+{"tool":"process","action":"poll","sessionId":"<id>"}
+```
+
+发送按键（tmux 风格）：
+
+```json
+{"tool":"process","action":"send-keys","sessionId":"<id>","keys":["Enter"]}
+{"tool":"process","action":"send-keys","sessionId":"<id>","keys":["C-c"]}
+{"tool":"process","action":"send-keys","sessionId":"<id>","keys":["Up","Up","Enter"]}
+```
+
+提交（仅发送回车）：
+
+```json
+{ "tool": "process", "action": "submit", "sessionId": "<id>" }
+```
+
+粘贴（默认带括号标记）：
+
+```json
+{ "tool": "process", "action": "paste", "sessionId": "<id>", "text": "line1\nline2\n" }
+```
+
+## apply_patch（实验性）
+
+`apply_patch` 是 `exec` 的子工具，用于结构化的多文件编辑。
+需显式启用：
+
+```json5
+{
+  tools: {
+    exec: {
+      applyPatch: { enabled: true, allowModels: ["gpt-5.2"] },
+    },
+  },
+}
+```
+
+说明：
+
+- 仅适用于 OpenAI/OpenAI Codex 模型。
+- 工具策略仍然适用；`allow: ["exec"]` 隐式允许 `apply_patch`。
+- 配置位于 `tools.exec.applyPatch` 下。

package/docs/zh-CN/tools/firecrawl.md

@@ -0,0 +1,65 @@
+---
+read_when:
+  - 你需要基于 Firecrawl 的网页提取
+  - 你需要 Firecrawl API 密钥
+  - 你需要为 web_fetch 提供反爬虫提取功能
+summary: Firecrawl 作为 web_fetch 的备用方案（反爬虫 + 缓存提取）
+title: Firecrawl
+x-i18n:
+  generated_at: "2026-02-01T21:42:22Z"
+  model: claude-opus-4-5
+  provider: pi
+  source_hash: 08a7ad45b41af41204e44d2b0be0f980b7184d80d2fa3977339e42a47beb2851
+  source_path: tools/firecrawl.md
+  workflow: 15
+---
+
+# Firecrawl
+
+OpenClaw 可以使用 **Firecrawl** 作为 `web_fetch` 的备用提取器。它是一个托管的内容提取服务，支持反爬虫绕过和缓存，有助于处理 JS 密集型网站或阻止普通 HTTP 请求的页面。
+
+## 获取 API 密钥
+
+1. 创建 Firecrawl 账户并生成 API 密钥。
+2. 将其存储在配置中，或在 Gateway网关环境中设置 `FIRECRAWL_API_KEY`。
+
+## 配置 Firecrawl
+
+```json5
+{
+  tools: {
+    web: {
+      fetch: {
+        firecrawl: {
+          apiKey: "FIRECRAWL_API_KEY_HERE",
+          baseUrl: "https://api.firecrawl.dev",
+          onlyMainContent: true,
+          maxAgeMs: 172800000,
+          timeoutSeconds: 60,
+        },
+      },
+    },
+  },
+}
+```
+
+注意事项：
+
+- 当存在 API 密钥时，`firecrawl.enabled` 默认为 true。
+- `maxAgeMs` 控制缓存结果的最大有效时长（毫秒）。默认为 2 天。
+
+## 隐身/反爬虫绕过
+
+Firecrawl 提供了一个用于反爬虫绕过的**代理模式**参数（`basic`、`stealth` 或 `auto`）。
+OpenClaw 对 Firecrawl 请求始终使用 `proxy: "auto"` 加上 `storeInCache: true`。
+如果省略 proxy，Firecrawl 默认使用 `auto`。`auto` 模式在基本尝试失败后会使用隐身代理重试，这可能比仅使用基本模式的抓取消耗更多积分。
+
+## `web_fetch` 如何使用 Firecrawl
+
+`web_fetch` 提取顺序：
+
+1. Readability（本地）
+2. Firecrawl（如已配置）
+3. 基本 HTML 清理（最终备用方案）
+
+参阅[网页工具](/tools/web)了解全部网页工具设置。