差分

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

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

​

クイックスタート

openclaw plugins install diffs

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

​

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

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

​

典型的なエージェントワークフロー

​

入力例

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

​

ツール入力リファレンス

​

出力details契約

​

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

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

​

Pluginデフォルト

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

​

成果物のライフサイクルとストレージ

• 成果物は一時サブフォルダー $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

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

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

​

セキュリティモデル

​

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

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

​

トラブルシューティング

​

運用ガイダンス

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

​

関連

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