Perbedaan

diffs adalah tool plugin opsional dengan panduan sistem bawaan singkat dan skill pendamping yang mengubah konten perubahan menjadi artefak diff baca-saja untuk agen.

Tool ini menerima salah satu dari:

• teks before dan after
• patch terpadu

Tool 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 ini menambahkan panduan penggunaan ringkas ke ruang system-prompt dan juga mengekspos skill mendetail 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 tool 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, tool, dan skill pendamping.

Jika Anda ingin menonaktifkan panduan dan tool sekaligus, nonaktifkan pluginnya.

# 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 tool

Semua bidang bersifat opsional kecuali dinyatakan lain.

# Kontrak detail output

Tool 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 ketika 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 ketika konteks yang dapat diperluas ada.

# Default plugin

Atur 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",
          },
        },
      },
    },
  },
}

Default yang didukung:

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

Parameter tool 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 temp: $TMPDIR/openclaw-diffs.
• Metadata artefak penampil berisi:
  • ID artefak acak (20 karakter hex)
  • token acak (48 karakter hex)
  • createdAt dan expiresAt
  • path viewer.html yang disimpan
• TTL artefak default adalah 30 menit ketika tidak ditentukan.
• TTL penampil maksimum yang diterima adalah 6 jam.
• Pembersihan berjalan secara oportunistik setelah pembuatan artefak.
• Artefak kedaluwarsa dihapus.
• Pembersihan fallback menghapus folder lama yang lebih dari 24 jam ketika 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

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

Perilaku konstruksi URL:

• Jika baseUrl panggilan tool disediakan, nilai tersebut digunakan setelah validasi ketat.
• Jika tidak, jika viewerBaseUrl plugin dikonfigurasi, nilai tersebut 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 berupa http:// atau https://.
• Query dan hash ditolak.
• Origin ditambah path 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 mengatur salah satu opsi path executable di atas.

# Pemecahan masalah

# Panduan operasional

• Pilih mode: "view" untuk ulasan interaktif lokal di kanvas.
• Pilih mode: "file" untuk kanal obrolan keluar yang membutuhkan lampiran.
• Biarkan allowRemoteViewer dinonaktifkan kecuali deployment Anda memerlukan URL penampil jarak jauh.
• Tetapkan ttlSeconds singkat secara 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").

# Terkait

• Browser
• Plugins
• Ikhtisar alat