Tools
Perbedaan
diffs adalah alat Plugin opsional dengan panduan sistem bawaan singkat dan Skills pendamping yang mengubah konten perubahan menjadi artefak diff baca-saja untuk agen.
Alat ini menerima salah satu dari:
- teks
beforedanafter patchterpadu
Alat ini dapat mengembalikan:
- URL penampil Gateway untuk presentasi kanvas
- path file yang dirender (PNG atau PDF) untuk pengiriman pesan
- kedua output dalam satu panggilan
Saat diaktifkan, Plugin menambahkan panduan penggunaan ringkas ke ruang system-prompt dan juga mengekspos Skills mendetail untuk kasus ketika agen memerlukan instruksi yang lebih lengkap.
Mulai cepat
Instal Plugin
openclaw plugins install diffsAktifkan Plugin
{ plugins: { entries: { diffs: { enabled: true, }, }, },}Pilih mode
view
Alur yang mengutamakan kanvas: agen memanggil diffs dengan mode: "view" dan membuka details.viewerUrl dengan canvas present.
file
Pengiriman file chat: agen memanggil diffs dengan mode: "file" dan mengirim details.filePath dengan message menggunakan path atau filePath.
both
Gabungan: agen memanggil diffs dengan mode: "both" untuk mendapatkan kedua artefak dalam satu panggilan.
Nonaktifkan panduan sistem bawaan
Jika Anda ingin tetap mengaktifkan alat diffs tetapi menonaktifkan panduan system-prompt 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 Skills pendamping.
Jika Anda ingin menonaktifkan panduan sekaligus alatnya, nonaktifkan Plugin sebagai gantinya.
Alur kerja agen umum
Panggil diffs
Agen memanggil alat diffs dengan input.
Baca detail
Agen membaca bidang details dari respons.
Presentasikan
Agen membuka details.viewerUrl dengan canvas present, mengirim details.filePath dengan message menggunakan path atau filePath, atau melakukan keduanya.
Contoh input
Sebelum dan sesudah
{ "before": "# Hello\n\nOne", "after": "# Hello\n\nTwo", "path": "docs/example.md", "mode": "view"}Patch
{ "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 bidang bersifat opsional kecuali dinyatakan lain.
beforestringTeks asli. Wajib bersama after saat patch tidak disertakan.
afterstringTeks yang diperbarui. Wajib bersama before saat patch tidak disertakan.
patchstringTeks diff terpadu. Saling eksklusif dengan before dan after.
pathstringNama file tampilan untuk mode sebelum dan sesudah.
langstringPetunjuk penggantian bahasa untuk mode sebelum dan sesudah. Nilai yang tidak dikenal dan bahasa di luar set penampil default kembali ke teks biasa kecuali Plugin Diff Viewer Language Pack diinstal.
titlestringPenggantian judul penampil.
mode"view" | "file" | "both"Mode output. Default-nya adalah default Plugin defaults.mode. Alias yang tidak digunakan lagi: "image" berperilaku seperti "file" dan masih diterima untuk kompatibilitas mundur.
theme"light" | "dark"Tema penampil. Default-nya adalah default Plugin defaults.theme.
layout"unified" | "split"Tata letak diff. Default-nya adalah default Plugin defaults.layout.
expandUnchangedbooleanPerluas bagian yang tidak berubah saat konteks penuh tersedia. Opsi per panggilan saja (bukan kunci default Plugin).
fileFormat"png" | "pdf"Format file yang dirender. Default-nya adalah default Plugin defaults.fileFormat.
fileQuality"standard" | "hq" | "print"Preset kualitas untuk rendering PNG atau PDF.
fileScalenumberPenggantian skala perangkat (1-4).
fileMaxWidthnumberLebar render maksimum dalam piksel CSS (640-2400).
ttlSecondsnumberdefault: 1800TTL artefak dalam detik untuk output penampil dan file mandiri. Maks 21600.
baseUrlstringPenggantian origin URL penampil. Mengganti Plugin viewerBaseUrl. Harus berupa http atau https, tanpa query/hash.
Alias input lama
Masih diterima untuk kompatibilitas mundur:
format->fileFormatimageFormat->fileFormatimageQuality->fileQualityimageScale->fileScaleimageMaxWidth->fileMaxWidth
Validasi dan batas
beforedanaftermasing-masing maksimal 512 KiB.patchmaksimal 2 MiB.pathmaksimal 2048 byte.langmaksimal 128 byte.titlemaksimal 1024 byte.- Batas kompleksitas patch: maksimal 128 file dan total 120000 baris.
patchbersamabeforeatauafterditolak.- Batas keamanan file yang dirender (berlaku untuk PNG dan PDF):
fileQuality: "standard": maksimal 8 MP (8.000.000 piksel yang dirender).fileQuality: "hq": maksimal 14 MP (14.000.000 piksel yang dirender).fileQuality: "print": maksimal 24 MP (24.000.000 piksel yang dirender).- PDF juga memiliki maksimum 50 halaman.
Penyorotan sintaks
OpenClaw menyertakan penyorotan sintaks untuk bahasa sumber, konfigurasi, dan dokumentasi umum:
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, dan toml.
Alias umum seperti js, ts, bash, md, yml, c++, dockerfile, rb, kt, dan ps1 dinormalisasi ke bahasa default tersebut.
Instal Plugin Diff Viewer Language Pack untuk menyorot bahasa lain:
openclaw plugins install clawhub:@openclaw/diffs-language-packDengan paket bahasa tersedia, OpenClaw dapat menyorot jauh lebih banyak bahasa. Jika paket tidak diinstal, file di luar daftar default tetap dirender sebagai teks polos yang mudah dibaca. Contohnya meliputi 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, dan file diff.
Lihat Plugin Diffs Language Pack untuk detail dan bahasa Shiki untuk katalog bahasa upstream dan alias Shiki.
Kontrak detail output
Alat ini mengembalikan metadata terstruktur di bawah details.
Kolom viewer
Kolom bersama untuk mode yang membuat viewer:
artifactIdviewerUrlviewerPathtitleexpiresAtinputKindfileCountmodecontext(agentId,sessionId,messageChannel,agentAccountIdsaat tersedia)
Kolom file
Kolom file saat PNG atau PDF dirender:
artifactIdexpiresAtfilePathpath(nilai yang sama denganfilePath, untuk kompatibilitas alat pesan)fileBytesfileFormatfileQualityfileScalefileMaxWidth
Alias kompatibilitas
Juga dikembalikan untuk pemanggil yang sudah ada:
format(nilai yang sama denganfileFormat)imagePath(nilai yang sama denganfilePath)imageBytes(nilai yang sama denganfileBytes)imageQuality(nilai yang sama denganfileQuality)imageScale(nilai yang sama denganfileScale)imageMaxWidth(nilai yang sama denganfileMaxWidth)
Ringkasan perilaku mode:
| Mode | Yang dikembalikan |
|---|---|
"view" |
Hanya kolom viewer. |
"file" |
Hanya kolom file, tanpa artefak viewer. |
"both" |
Kolom viewer ditambah kolom file. Jika rendering file gagal, viewer tetap dikembalikan dengan alias fileError dan imageError. |
Bagian tidak berubah yang diciutkan
- Viewer 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 lazim 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.
expandUnchangedhanya berlaku saat konteks yang dapat diperluas tersedia.
Default Plugin
Tetapkan default di seluruh Plugin dalam ~/.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:
fontFamilyfontSizelineSpacinglayoutshowLineNumbersdiffIndicatorswordWrapbackgroundthemefileFormatfileQualityfileScalefileMaxWidthmodettlSeconds
Parameter alat eksplisit menimpa default ini.
Konfigurasi URL viewer persisten
viewerBaseUrlstringFallback milik Plugin untuk tautan viewer yang dikembalikan saat panggilan alat tidak meneruskan baseUrl. Harus berupa http atau https, tanpa query/hash.
{ plugins: { entries: { diffs: { enabled: true, config: { viewerBaseUrl: "https://gateway.example.com/openclaw", }, }, }, },}Konfigurasi keamanan
security.allowRemoteViewerbooleandefault: falsefalse: permintaan non-loopback ke rute viewer ditolak. true: viewer jarak jauh diizinkan jika path bertoken valid.
{ plugins: { entries: { diffs: { enabled: true, config: { security: { allowRemoteViewer: false, }, }, }, }, },}Siklus hidup dan penyimpanan artefak
- Artefak disimpan di bawah subfolder temp:
$TMPDIR/openclaw-diffs. - Metadata artefak penampil berisi:
- ID artefak acak (20 karakter hex)
- token acak (48 karakter hex)
createdAtdanexpiresAt- path
viewer.htmlyang tersimpan
- TTL artefak default adalah 30 menit jika tidak ditentukan.
- TTL penampil maksimum yang diterima adalah 6 jam.
- Pembersihan berjalan secara oportunistis setelah artefak dibuat.
- Artefak yang kedaluwarsa dihapus.
- Pembersihan fallback menghapus folder usang yang lebih lama dari 24 jam jika metadata tidak ada.
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/plugins/diffs-language-pack/assets/viewer.jssaat diff menggunakan bahasa dari Diff Viewer Language Pack
Dokumen penampil menyelesaikan aset tersebut relatif terhadap URL penampil, sehingga prefiks path baseUrl opsional juga dipertahankan untuk kedua permintaan aset.
Perilaku konstruksi URL:
- Jika
baseUrlpanggilan alat disediakan, nilai itu digunakan setelah validasi ketat. - Jika tidak, jika
viewerBaseUrlPlugin dikonfigurasi, nilai itu digunakan. - Tanpa salah satu override tersebut, URL penampil default ke loopback
127.0.0.1. - Jika mode bind Gateway adalah
customdangateway.customBindHostdiatur, host tersebut digunakan.
Aturan baseUrl:
- Harus berupa
http://atauhttps://. - Query dan hash ditolak.
- Origin plus path dasar opsional diizinkan.
Model keamanan
Viewer hardening
- Hanya loopback secara default.
- Path penampil bertoken dengan validasi ID dan token yang ketat.
- CSP respons penampil:
default-src 'none'- skrip dan aset hanya dari self
- tanpa
connect-srckeluar
- Pembatasan miss jarak jauh saat akses jarak jauh diaktifkan:
- 40 kegagalan per 60 detik
- penguncian 60 detik (
429 Too Many Requests)
File rendering hardening
- Routing permintaan browser tangkapan layar bersifat tolak-secara-default.
- Hanya aset penampil lokal dari
http://127.0.0.1/plugins/diffs/assets/*yang diizinkan. - Permintaan jaringan eksternal diblokir.
Persyaratan browser untuk mode file
mode: "file" dan mode: "both" memerlukan browser yang kompatibel dengan Chromium.
Urutan resolusi:
Config
browser.executablePath dalam konfigurasi OpenClaw.
Environment variables
OPENCLAW_BROWSER_EXECUTABLE_PATHBROWSER_EXECUTABLE_PATHPLAYWRIGHT_CHROMIUM_EXECUTABLE_PATH
Platform fallback
Fallback penemuan perintah/path platform.
Teks kegagalan umum:
Diff PNG/PDF rendering requires a Chromium-compatible browser...
Perbaiki dengan menginstal Chrome, Chromium, Edge, atau Brave, atau mengatur salah satu opsi path executable di atas.
Pemecahan masalah
Input validation errors
Provide patch or both before and after text.— sertakanbeforedanafter, atau berikanpatch.Provide either patch or before/after input, not both.— jangan mencampur mode input.Invalid baseUrl: ...— gunakan originhttp(s)dengan path opsional, tanpa query/hash.{field} exceeds maximum size (...)— kurangi ukuran payload.- Penolakan patch besar — kurangi jumlah file patch atau total baris.
Viewer accessibility
- URL penampil diselesaikan ke
127.0.0.1secara default. - Untuk skenario akses jarak jauh, salah satu:
- atur
viewerBaseUrlPlugin, atau - teruskan
baseUrlper panggilan alat, atau - gunakan
gateway.bind=customdangateway.customBindHost
- atur
- Jika
gateway.trustedProxiesmenyertakan loopback untuk proxy host yang sama (misalnya Tailscale Serve), permintaan penampil loopback mentah tanpa header IP klien yang diteruskan gagal tertutup sesuai desain. - Untuk topologi proxy tersebut:
- pilih
mode: "file"ataumode: "both"saat Anda hanya membutuhkan lampiran, atau - aktifkan
security.allowRemoteViewersecara sengaja dan aturviewerBaseUrlPlugin atau teruskanbaseUrlproxy/publik saat Anda membutuhkan URL penampil yang dapat dibagikan
- pilih
- Aktifkan
security.allowRemoteViewerhanya saat Anda memang menginginkan akses penampil eksternal.
Unmodified-lines row has no expand button
Ini dapat terjadi untuk input patch saat patch tidak membawa konteks yang dapat diperluas. Ini diharapkan dan tidak menunjukkan kegagalan penampil.
Artifact not found
- Artefak kedaluwarsa karena TTL.
- Token atau path berubah.
- Pembersihan menghapus data usang.
Panduan operasional
- Pilih
mode: "view"untuk peninjauan interaktif lokal di canvas. - Pilih
mode: "file"untuk kanal obrolan keluar yang membutuhkan lampiran. - Biarkan
allowRemoteViewerdinonaktifkan kecuali deployment Anda memerlukan URL penampil jarak jauh. - Tetapkan
ttlSecondssingkat yang eksplisit untuk diff sensitif. - Hindari mengirim rahasia dalam input diff jika tidak diperlukan.
- Jika kanal Anda mengompresi gambar secara agresif (misalnya Telegram atau WhatsApp), pilih output PDF (
fileFormat: "pdf").