Perbedaan

diffs adalah alat Plugin opsional dengan panduan sistem bawaan yang ringkas dan skill pendamping yang mengubah konten perubahan menjadi artefak diff baca-saja untuk agen.

Ini menerima salah satu dari:

• teks before dan after
• patch terpadu

Ini dapat mengembalikan:

• URL penampil gateway untuk presentasi canvas
• jalur file yang dirender (PNG atau PDF) untuk pengiriman pesan
• kedua keluaran dalam satu panggilan

Saat diaktifkan, Plugin menambahkan panduan penggunaan ringkas ke ruang prompt sistem dan juga mengekspos skill terperinci untuk kasus ketika agen membutuhkan instruksi yang lebih lengkap.

Mulai cepat

openclaw plugins install diffs

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

Nonaktifkan panduan sistem bawaan

Jika Anda ingin tetap mengaktifkan alat diffs tetapi menonaktifkan panduan prompt sistem bawaannya, atur plugins.entries.diffs.hooks.allowPromptInjection ke false:

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

Ini memblokir hook before_prompt_build milik Plugin diffs sambil tetap menyediakan Plugin, alat, dan skill pendamping.

Jika Anda ingin menonaktifkan panduan sekaligus alatnya, nonaktifkan Plugin sebagai gantinya.

Alur kerja agen umum

Contoh input

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

Referensi input alat

Semua field bersifat opsional kecuali disebutkan.

Kontrak detail keluaran

Alat mengembalikan metadata terstruktur di bawah details.

Ringkasan perilaku mode:

Bagian tidak berubah yang diciutkan

• Penampil dapat menampilkan baris seperti N unmodified lines.
• Kontrol perluas pada baris tersebut bersifat kondisional dan tidak dijamin untuk setiap jenis input.
• Kontrol perluas muncul saat diff yang dirender memiliki data konteks yang dapat diperluas, yang umum untuk input sebelum dan sesudah.
• Untuk banyak input patch terpadu, isi konteks yang dihilangkan tidak tersedia dalam hunk patch yang diurai, sehingga baris dapat muncul tanpa kontrol perluas. Ini adalah perilaku yang diharapkan.
• expandUnchanged hanya berlaku saat konteks yang dapat diperluas ada.

Default Plugin

Atur default seluruh Plugin di ~/.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,          },        },      },    },  },}

Default yang didukung:

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

Parameter alat eksplisit menimpa default ini.

Konfigurasi URL penampil persisten

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

Konfigurasi keamanan

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

Siklus hidup dan penyimpanan artefak

• Artefak disimpan di bawah subfolder sementara: $TMPDIR/openclaw-diffs.
• Metadata artefak penampil berisi:
  • ID artefak acak (20 karakter hex)
  • token acak (48 karakter hex)
  • createdAt dan expiresAt
  • jalur viewer.html yang disimpan
• TTL artefak default adalah 30 menit saat tidak ditentukan.
• TTL penampil maksimum yang diterima adalah 6 jam.
• Pembersihan berjalan secara oportunistik setelah pembuatan artefak.
• Artefak kedaluwarsa dihapus.
• Pembersihan fallback menghapus folder usang yang lebih lama dari 24 jam saat metadata hilang.

URL penampil dan perilaku jaringan

Rute penampil:

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

Aset penampil:

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

Dokumen penampil menyelesaikan aset tersebut relatif terhadap URL penampil, sehingga prefiks jalur baseUrl opsional juga dipertahankan untuk kedua permintaan aset.

Perilaku konstruksi URL:

• Jika baseUrl panggilan alat diberikan, itu digunakan setelah validasi ketat.
• Jika tidak, jika viewerBaseUrl Plugin dikonfigurasi, itu digunakan.
• Tanpa salah satu penimpaan, URL penampil default ke loopback 127.0.0.1.
• Jika mode bind Gateway adalah custom dan gateway.customBindHost diatur, host tersebut digunakan.

Aturan baseUrl:

• Harus http:// atau https://.
• Query dan hash ditolak.
• Origin plus jalur dasar opsional diizinkan.

Model keamanan

Persyaratan browser untuk mode file

mode: "file" dan mode: "both" memerlukan browser yang kompatibel dengan Chromium.

Urutan resolusi:

Teks kegagalan umum:

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

Perbaiki dengan menginstal Chrome, Chromium, Edge, atau Brave, atau dengan mengatur salah satu opsi jalur executable di atas.

Pemecahan masalah

Panduan operasional

• Pilih mode: "view" untuk peninjauan interaktif lokal di canvas.
• Pilih mode: "file" untuk kanal chat keluar yang memerlukan lampiran.
• Biarkan allowRemoteViewer dinonaktifkan kecuali deployment Anda memerlukan URL viewer jarak jauh.
• Tetapkan ttlSeconds singkat secara eksplisit untuk diff sensitif.
• Hindari mengirim rahasia dalam input diff saat tidak diperlukan.
• Jika kanal Anda mengompresi gambar secara agresif (misalnya Telegram atau WhatsApp), pilih output PDF (fileFormat: "pdf").

Terkait

• Browser
• Plugins
• Ikhtisar tools