差分

diffs は、短い組み込みシステムガイダンスとコンパニオン Skill を備えた任意の Plugin ツールで、変更内容をエージェント向けの読み取り専用 diff アーティファクトに変換します。

次のいずれかを受け付けます。

• before と after のテキスト
• 統一形式の patch

次を返せます。

• canvas 表示用の Gateway viewer URL
• メッセージ配信用のレンダリング済みファイルパス（PNG または PDF）
• 1 回の呼び出しで両方の出力

有効にすると、この Plugin はシステムプロンプト領域に簡潔な使用ガイダンスを追加し、エージェントがより詳しい手順を必要とする場合のために詳細な Skill も公開します。

クイックスタート

openclaw plugins install diffs

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

組み込みシステムガイダンスを無効にする

diffs ツールを有効にしたまま、その組み込みシステムプロンプトガイダンスを無効にしたい場合は、plugins.entries.diffs.hooks.allowPromptInjection を false に設定します。

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

これにより、Plugin、ツール、コンパニオン Skill は利用可能なまま、diffs Plugin の before_prompt_build フックがブロックされます。

ガイダンスとツールの両方を無効にしたい場合は、代わりに Plugin を無効にします。

一般的なエージェントワークフロー

入力例

{  "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"}

ツール入力リファレンス

特記がない限り、すべてのフィールドは任意です。

構文ハイライト

OpenClaw には、一般的なソース、設定、ドキュメント言語の構文ハイライトが含まれています。

javascript, typescript, tsx, jsx, json, markdown, yaml, css, html, sh, python, go, rust, java, c, cpp, csharp, php, sql, docker, ruby, swift, kotlin, r, dart, lua, powershell, xml, toml。

js, ts, bash, md, yml, c++, dockerfile, rb, kt, ps1 などの一般的なエイリアスは、これらのデフォルト言語に正規化されます。

Diff Viewer Language Pack Plugin をインストールして、他の言語をハイライトします。

openclaw plugins install clawhub:@openclaw/diffs-language-pack

言語パックが利用可能になると、OpenClaw はさらに多くの言語をハイライトできます。パックがインストールされていない場合でも、デフォルトリスト外のファイルは読みやすいプレーンテキストとしてレンダリングされます。例には Astro、Vue、Svelte、MDX、GraphQL、Terraform/HCL、Nix、Clojure、Elixir、Haskell、OCaml、Scala、Zig、Solidity、Verilog/VHDL、Fortran、MATLAB、LaTeX、Mermaid、Sass/Less/SCSS、Nginx、Apache、CSV、dotenv、INI、diff ファイルが含まれます。

詳細は Diffs Language Pack Plugin を、Shiki の上流言語とエイリアスカタログは Shiki languages を参照してください。

出力詳細の契約

このツールは details の下に構造化メタデータを返します。

モード動作の概要:

折りたたまれた未変更セクション

• ビューアーは N unmodified lines のような行を表示できます。
• それらの行の展開コントロールは条件付きであり、すべての入力種別で保証されるわけではありません。
• 展開コントロールは、レンダリングされた diff に展開可能なコンテキストデータがある場合に表示されます。これは before と after の入力で一般的です。
• 多くの unified patch 入力では、省略されたコンテキスト本文は解析済みパッチハンクで利用できないため、行が展開コントロールなしで表示されることがあります。これは想定される動作です。
• expandUnchanged は、展開可能なコンテキストが存在する場合にのみ適用されます。

Plugin のデフォルト

Plugin 全体のデフォルトを ~/.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",            ttlSeconds: 21600,          },        },      },    },  },}

サポートされるデフォルト:

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

明示的なツールパラメーターはこれらのデフォルトを上書きします。

永続的なビューアー URL 設定

{  plugins: {    entries: {      diffs: {        enabled: true,        config: {          viewerBaseUrl: "https://gateway.example.com/openclaw",        },      },    },  },}

セキュリティ設定

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

アーティファクトのライフサイクルとストレージ

• アーティファクトは temp サブフォルダー $TMPDIR/openclaw-diffs の下に保存されます。
• ビューアアーティファクトのメタデータには次が含まれます:
  • ランダムなアーティファクト ID (20 桁の 16 進文字)
  • ランダムなトークン (48 桁の 16 進文字)
  • 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
• diff が Diff Viewer Language Pack の言語を使用する場合は /plugins/diffs-language-pack/assets/viewer.js

ビューアドキュメントはそれらのアセットをビューア URL からの相対パスとして解決するため、任意の baseUrl パスプレフィックスも両方のアセットリクエストで保持されます。

URL 構築の動作:

• ツール呼び出しの baseUrl が指定されている場合、厳密な検証後に使用されます。
• それ以外で Plugin の viewerBaseUrl が設定されている場合、それが使用されます。
• どちらの上書きもない場合、ビューア URL はデフォルトで loopback 127.0.0.1 になります。
• Gateway バインドモードが custom で、gateway.customBindHost が設定されている場合、そのホストが使用されます。

baseUrl のルール:

• http:// または https:// である必要があります。
• クエリとハッシュは拒否されます。
• オリジンと任意のベースパスが許可されます。

セキュリティモデル

ファイルモードのブラウザー要件

mode: "file" と mode: "both" には Chromium 互換ブラウザーが必要です。

解決順序:

一般的な失敗テキスト:

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

Chrome、Chromium、Edge、Brave をインストールするか、上記の実行可能ファイルパスオプションのいずれかを設定して修正します。

トラブルシューティング

運用ガイダンス

• キャンバスでのローカル対話型レビューには mode: "view" を優先します。
• 添付ファイルが必要なアウトバウンドチャットチャネルには mode: "file" を優先します。
• デプロイでリモートビューア URL が必要な場合を除き、allowRemoteViewer は無効のままにします。
• 機密性の高い diff には明示的に短い ttlSeconds を設定します。
• 必要でない場合は、diff 入力にシークレットを送信しないでください。
• チャネルが画像を強く圧縮する場合 (たとえば Telegram や WhatsApp)、PDF 出力 (fileFormat: "pdf") を優先します。

関連

• ブラウザー
• Plugin
• ツール概要