Verschillen

diffs is een optionele Plugin-tool met korte ingebouwde systeemrichtlijnen en een bijbehorende skill die wijzigingsinhoud omzet in een alleen-lezen diffartefact voor agents.

Deze accepteert een van beide:

• before- en after-tekst
• een uniforme patch

Deze kan retourneren:

• een Gateway-viewer-URL voor canvaspresentatie
• een gerenderd bestandspad (PNG of PDF) voor berichtbezorging
• beide uitvoeritems in één aanroep

Wanneer ingeschakeld, voegt de Plugin beknopte gebruiksrichtlijnen toe aan de systeempromptruimte en stelt deze ook een gedetailleerde skill beschikbaar voor gevallen waarin de agent uitgebreidere instructies nodig heeft.

# Snel aan de slag

openclaw plugins install diffs

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

# Ingebouwde systeemrichtlijnen uitschakelen

Als je de diffs-tool ingeschakeld wilt houden maar de ingebouwde systeempromptrichtlijnen wilt uitschakelen, stel je plugins.entries.diffs.hooks.allowPromptInjection in op false:

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

Dit blokkeert de before_prompt_build-hook van de diffs-Plugin, terwijl de Plugin, tool en bijbehorende skill beschikbaar blijven.

Als je zowel de richtlijnen als de tool wilt uitschakelen, schakel dan in plaats daarvan de Plugin uit.

# Typische agent-workflow

# Invoervoorbeelden

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

# Referentie voor toolinvoer

Alle velden zijn optioneel tenzij anders vermeld.

# Contract voor uitvoerdetails

De tool retourneert gestructureerde metadata onder details.

Samenvatting van modusgedrag:

# Samengevouwen ongewijzigde secties

• De viewer kan rijen tonen zoals N unmodified lines.
• Uitvouwbesturingselementen op die rijen zijn voorwaardelijk en niet gegarandeerd voor elk invoertype.
• Uitvouwbesturingselementen verschijnen wanneer de gerenderde diff uitbreidbare contextgegevens heeft, wat typisch is voor voor-en-na-invoer.
• Voor veel uniforme patchinvoer zijn weggelaten contextinhouden niet beschikbaar in de geparste patch-hunks, dus de rij kan verschijnen zonder uitvouwbesturingselementen. Dit is verwacht gedrag.
• expandUnchanged is alleen van toepassing wanneer uitbreidbare context bestaat.

# Plugin-standaarden

Stel Plugin-brede standaarden in ~/.openclaw/openclaw.json in:

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

Ondersteunde standaarden:

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

Expliciete toolparameters overschrijven deze standaarden.

# Persistente configuratie voor viewer-URL

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

# Beveiligingsconfiguratie

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

# Levenscyclus en opslag van artefacten

• Artefacten worden opgeslagen onder de tijdelijke submap: $TMPDIR/openclaw-diffs.
• Metadata van viewerartefacten bevat:
  • willekeurige artefact-ID (20 hextekens)
  • willekeurige token (48 hextekens)
  • createdAt en expiresAt
  • opgeslagen viewer.html-pad
• De standaard artefact-TTL is 30 minuten wanneer niet opgegeven.
• De maximaal geaccepteerde viewer-TTL is 6 uur.
• Opschoning wordt opportunistisch uitgevoerd na het maken van artefacten.
• Verlopen artefacten worden verwijderd.
• Terugvalopschoning verwijdert verouderde mappen ouder dan 24 uur wanneer metadata ontbreekt.

# Viewer-URL en netwerkgedrag

Viewerroute:

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

Viewerassets:

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

Het viewerdocument resolveert die assets relatief ten opzichte van de viewer-URL, zodat een optioneel baseUrl-padvoorvoegsel ook voor beide assetaanvragen behouden blijft.

URL-constructiegedrag:

• Als baseUrl van de toolaanroep is opgegeven, wordt deze gebruikt na strikte validatie.
• Anders, als Plugin viewerBaseUrl is geconfigureerd, wordt deze gebruikt.
• Zonder een van beide overschrijvingen wordt de viewer-URL standaard ingesteld op loopback 127.0.0.1.
• Als de Gateway-bindmodus custom is en gateway.customBindHost is ingesteld, wordt die host gebruikt.

baseUrl-regels:

• Moet http:// of https:// zijn.
• Query en hash worden geweigerd.
• Oorsprong plus optioneel basispad is toegestaan.

# Beveiligingsmodel

# Browservereisten voor bestandsmodus

mode: "file" en mode: "both" hebben een Chromium-compatibele browser nodig.

Volgorde van oplossing:

Veelvoorkomende fouttekst:

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

Los dit op door Chrome, Chromium, Edge of Brave te installeren, of door een van de opties voor het uitvoerbare pad hierboven in te stellen.

# Probleemoplossing

# Operationele richtlijnen

• Geef de voorkeur aan mode: "view" voor lokale interactieve reviews in canvas.
• Geef de voorkeur aan mode: "file" voor uitgaande chatkanalen die een bijlage nodig hebben.
• Houd allowRemoteViewer uitgeschakeld tenzij je implementatie externe viewer-URL's vereist.
• Stel expliciete korte ttlSeconds in voor gevoelige diffs.
• Vermijd het verzenden van geheimen in diff-invoer wanneer dit niet vereist is.
• Als je kanaal afbeeldingen agressief comprimeert (bijvoorbeeld Telegram of WhatsApp), geef dan de voorkeur aan PDF-uitvoer (fileFormat: "pdf").

# Gerelateerd

• Browser
• Plugins
• Tools-overzicht