Diffs

diffs 是一个可选的插件工具，带有简短的内置系统引导和配套技能，把变更内容转换成只读的 diff 制品供代理使用。

它接受以下任一输入：

before 和 after 文本
统一格式的 patch

它可以返回：

用于画布展示的网关查看器 URL
用于消息投递的渲染文件路径（PNG 或 PDF）
一次调用中同时返回两种输出

启用后，插件会在系统提示中注入简洁的使用引导，同时暴露一个详细技能供代理需要更完整的指令时使用。

快速上手

启用插件。
用 mode: "view" 调用 diffs 来走画布优先的流程。
用 mode: "file" 走聊天文件投递流程。
用 mode: "both" 同时获取两种制品。

启用插件

{
  plugins: {
    entries: {
      diffs: {
        enabled: true,
      },
    },
  },
}

禁用内置系统引导

如果你想保留 diffs 工具但禁用它的内置系统提示引导，把 plugins.entries.diffs.hooks.allowPromptInjection 设为 false：

{
  plugins: {
    entries: {
      diffs: {
        enabled: true,
        hooks: {
          allowPromptInjection: false,
        },
      },
    },
  },
}

这会阻止 diffs 插件的 before_prompt_build 钩子，同时保留插件、工具和配套技能。

如果你想同时禁用引导和工具，直接禁用插件。

典型代理工作流

代理调用 diffs。
代理读取 details 字段。
代理选择：
- 用 canvas present 打开 details.viewerUrl
- 用 message 发送 details.filePath（使用 path 或 filePath）
- 两者都做

输入示例

前后对比：

{
  "before": "# Hello\n\nOne",
  "after": "# Hello\n\nTwo",
  "path": "docs/example.md",
  "mode": "view"
}

补丁：

{
  "patch": "diff --git a/src/example.ts b/src/example.ts\n--- a/src/example.ts\n+++ b/src/example.ts\n@@ -1 +1 @@\n-const x = 1;\n+const x = 2;\n",
  "mode": "both"
}

工具输入参考

除非标注，所有字段均为可选：

before（string）：原始文本。省略 patch 时必须和 after 一起提供。
after（string）：更新后文本。省略 patch 时必须和 before 一起提供。
patch（string）：统一 diff 文本。与 before 和 after 互斥。
path（string）：前后对比模式的显示文件名。
lang（string）：前后对比模式的语言覆盖提示。
title（string）：查看器标题覆盖。
mode（"view" | "file" | "both"）：输出模式。默认为插件默认的 defaults.mode。
theme（"light" | "dark"）：查看器主题。默认为插件默认的 defaults.theme。
layout（"unified" | "split"）：diff 布局。默认为插件默认的 defaults.layout。
expandUnchanged（boolean）：当有完整上下文时展开未变更部分。仅限每次调用的选项（不是插件默认键）。
fileFormat（"png" | "pdf"）：渲染文件格式。默认为插件默认的 defaults.fileFormat。
fileQuality（"standard" | "hq" | "print"）：PNG 或 PDF 渲染的质量预设。
fileScale（number）：设备缩放覆盖（1-4）。
fileMaxWidth（number）：CSS 像素最大渲染宽度（640-2400）。
ttlSeconds（number）：查看器制品 TTL（秒）。默认 1800，最大 21600。
baseUrl（string）：查看器 URL 源覆盖。必须是 http 或 https，不含查询/哈希。

验证和限制：

before 和 after 各最大 512 KiB。
patch 最大 2 MiB。
path 最大 2048 字节。
lang 最大 128 字节。
title 最大 1024 字节。
补丁复杂度上限：最多 128 个文件和 120000 总行数。
同时提供 patch 和 before 或 after 会被拒绝。
渲染文件安全限制（适用于 PNG 和 PDF）：
- fileQuality: "standard"：最大 8 MP（8,000,000 渲染像素）。
- fileQuality: "hq"：最大 14 MP（14,000,000 渲染像素）。
- fileQuality: "print"：最大 24 MP（24,000,000 渲染像素）。
- PDF 还有最大 50 页的限制。

输出详情合约

工具在 details 下返回结构化元数据。

创建查看器的模式共享的字段：

artifactId
viewerUrl
viewerPath
title
expiresAt
inputKind
fileCount
mode

渲染 PNG 或 PDF 时的文件字段：

filePath
path（和 filePath 值相同，用于 message 工具兼容性）
fileBytes
fileFormat
fileQuality
fileScale
fileMaxWidth

模式行为总结：

mode: "view"：仅查看器字段。
mode: "file"：仅文件字段，不创建查看器制品。
mode: "both"：查看器字段加文件字段。如果文件渲染失败，查看器仍然返回并附带 fileError。

折叠的未变更部分

查看器可以显示类似 N unmodified lines 的行。
这些行上的展开控件是有条件的，不保证对每种输入类型都有。
当渲染的 diff 有可展开的上下文数据时展开控件会出现，这在前后对比输入中很常见。
对于很多统一补丁输入，被省略的上下文内容在解析的补丁块中不可用，所以该行可能没有展开控件。这是预期行为。
expandUnchanged 仅在存在可展开上下文时生效。

插件默认值

在 ~/.openclaw/openclaw.json 中设置插件级默认值：

{
  plugins: {
    entries: {
      diffs: {
        enabled: true,
        config: {
          defaults: {
            fontFamily: "Fira Code",
            fontSize: 15,
            lineSpacing: 1.6,
            layout: "unified",
            showLineNumbers: true,
            diffIndicators: "bars",
            wordWrap: true,
            background: true,
            theme: "dark",
            fileFormat: "png",
            fileQuality: "standard",
            fileScale: 2,
            fileMaxWidth: 960,
            mode: "both",
          },
        },
      },
    },
  },
}

支持的默认值：

fontFamily
fontSize
lineSpacing
layout
showLineNumbers
diffIndicators
wordWrap
background
theme
fileFormat
fileQuality
fileScale
fileMaxWidth
mode

显式的工具参数会覆盖这些默认值。

安全配置

security.allowRemoteViewer（boolean，默认 false）
- false：拒绝非回环的查看器路由请求。
- true：如果令牌化路径有效则允许远程查看器。

示例：

{
  plugins: {
    entries: {
      diffs: {
        enabled: true,
        config: {
          security: {
            allowRemoteViewer: false,
          },
        },
      },
    },
  },
}

制品生命周期和存储

制品存储在临时子文件夹下：$TMPDIR/openclaw-diffs。
查看器制品元数据包含：
- 随机制品 ID（20 个十六进制字符）
- 随机令牌（48 个十六进制字符）
- createdAt 和 expiresAt
- 存储的 viewer.html 路径
未指定时默认查看器 TTL 为 30 分钟。
最大接受的查看器 TTL 为 6 小时。
清理在制品创建后伺机运行。
过期制品会被删除。
元数据缺失时，对超过 24 小时的陈旧文件夹进行回退清理。

查看器 URL 和网络行为

查看器路由：

/plugins/diffs/view/{artifactId}/{token}

查看器资源：

/plugins/diffs/assets/viewer.js
/plugins/diffs/assets/viewer-runtime.js

URL 构建行为：

如果提供了 baseUrl，经过严格验证后使用。
没有 baseUrl 时，查看器 URL 默认指向回环 127.0.0.1。
如果网关绑定模式是 custom 且设置了 gateway.customBindHost，则使用该主机。

baseUrl 规则：

必须是 http:// 或 https://。
查询和哈希会被拒绝。
允许源加上可选的基路径。

安全模型

查看器加固：

默认仅限回环。
带严格 ID 和令牌验证的令牌化查看器路径。
查看器响应 CSP：
- default-src 'none'
- 脚本和资源仅来自 self
- 无出站 connect-src
远程访问启用时的未命中节流：
- 60 秒内 40 次失败
- 60 秒锁定（429 Too Many Requests）

文件渲染加固：

截图浏览器请求路由默认拒绝。
只允许来自 http://127.0.0.1/plugins/diffs/assets/* 的本地查看器资源。
外部网络请求被阻止。

文件模式的浏览器要求

mode: "file" 和 mode: "both" 需要兼容 Chromium 的浏览器。

解析顺序：

OpenClaw 配置中的 browser.executablePath。
环境变量：
- OPENCLAW_BROWSER_EXECUTABLE_PATH
- BROWSER_EXECUTABLE_PATH
- PLAYWRIGHT_CHROMIUM_EXECUTABLE_PATH
平台命令/路径发现回退。

常见失败文本：

Diff PNG/PDF rendering requires a Chromium-compatible browser...

安装 Chrome、Chromium、Edge 或 Brave，或设置上述可执行路径选项之一即可修复。

故障排除

输入验证错误：

Provide patch or both before and after text.
- 同时提供 before 和 after，或提供 patch。
Provide either patch or before/after input, not both.
- 不要混用输入模式。
Invalid baseUrl: ...
- 使用 http(s) 源加可选路径，不含查询/哈希。
{field} exceeds maximum size (...)
- 缩小负载大小。
大补丁被拒绝
- 减少补丁文件数或总行数。

查看器可访问性问题：

查看器 URL 默认解析到 127.0.0.1。
远程访问场景下，要么：
- 每次工具调用传 baseUrl，或
- 使用 gateway.bind=custom 加 gateway.customBindHost
只有当你确实需要外部查看器访问时才启用 security.allowRemoteViewer。

未变更行没有展开按钮：

补丁输入不带可展开上下文时会出现这种情况。
这是预期行为，不表示查看器故障。

制品未找到：

制品因 TTL 过期。
令牌或路径变了。
清理移除了陈旧数据。

操作指南

本地交互审查优先用 mode: "view" 配合画布。
需要附件的出站聊天频道用 mode: "file"。
除非部署确实需要远程查看器 URL，否则保持 allowRemoteViewer 禁用。
敏感 diff 设置较短的 ttlSeconds。
不必要时避免在 diff 输入中发送敏感信息。
如果你的频道会大力压缩图片（比如 Telegram 或 WhatsApp），优先使用 PDF 输出（fileFormat: "pdf"）。

Diff 渲染引擎：

基于 Diffs。