Zum Hauptinhalt springen

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.

diffs ist ein optionales Plugin-Tool mit kurzer integrierter Systemanleitung und einer begleitenden Skill, die Änderungsinhalte in ein schreibgeschütztes Diff-Artefakt für Agents umwandelt. Es akzeptiert entweder:
  • before- und after-Text
  • einen vereinheitlichten patch
Es kann zurückgeben:
  • eine Gateway-Viewer-URL für Canvas-Präsentationen
  • einen gerenderten Dateipfad (PNG oder PDF) für die Nachrichtenzustellung
  • beide Ausgaben in einem Aufruf
Wenn es aktiviert ist, stellt das Plugin dem System-Prompt-Bereich eine knappe Nutzungsanleitung voran und stellt außerdem eine detaillierte Skill für Fälle bereit, in denen der Agent ausführlichere Anweisungen benötigt.

Schnellstart

1

Plugin installieren

openclaw plugins install diffs
2

Plugin aktivieren

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

Modus auswählen

Canvas-zuerst-Abläufe: Agents rufen diffs mit mode: "view" auf und öffnen details.viewerUrl mit canvas present.

Integrierte Systemanleitung deaktivieren

Wenn Sie das diffs-Tool aktiviert lassen, aber seine integrierte System-Prompt-Anleitung deaktivieren möchten, setzen Sie plugins.entries.diffs.hooks.allowPromptInjection auf false:
{
  plugins: {
    entries: {
      diffs: {
        enabled: true,
        hooks: {
          allowPromptInjection: false,
        },
      },
    },
  },
}
Dies blockiert den before_prompt_build-Hook des diffs-Plugins, während Plugin, Tool und begleitende Skill verfügbar bleiben. Wenn Sie sowohl die Anleitung als auch das Tool deaktivieren möchten, deaktivieren Sie stattdessen das Plugin.

Typischer Agent-Workflow

1

diffs aufrufen

Der Agent ruft das diffs-Tool mit Eingabe auf.
2

Details lesen

Der Agent liest details-Felder aus der Antwort.
3

Präsentieren

Der Agent öffnet entweder details.viewerUrl mit canvas present, sendet details.filePath mit message unter Verwendung von path oder filePath oder tut beides.

Eingabebeispiele

{
  "before": "# Hello\n\nOne",
  "after": "# Hello\n\nTwo",
  "path": "docs/example.md",
  "mode": "view"
}

Tool-Eingabereferenz

Alle Felder sind optional, sofern nicht anders angegeben.
before
string
Ursprünglicher Text. Erforderlich mit after, wenn patch ausgelassen wird.
after
string
Aktualisierter Text. Erforderlich mit before, wenn patch ausgelassen wird.
patch
string
Vereinheitlichter Diff-Text. Schließt sich gegenseitig mit before und after aus.
path
string
Anzuzeigender Dateiname für den Vorher-und-nachher-Modus.
lang
string
Sprachüberschreibungshinweis für den Vorher-und-nachher-Modus. Unbekannte Werte fallen auf Nur-Text zurück.
title
string
Überschreibung des Viewer-Titels.
mode
"view" | "file" | "both"
Ausgabemodus. Standardmäßig der Plugin-Standardwert defaults.mode. Veralteter Alias: "image" verhält sich wie "file" und wird aus Gründen der Abwärtskompatibilität weiterhin akzeptiert.
theme
"light" | "dark"
Viewer-Theme. Standardmäßig der Plugin-Standardwert defaults.theme.
layout
"unified" | "split"
Diff-Layout. Standardmäßig der Plugin-Standardwert defaults.layout.
expandUnchanged
boolean
Unveränderte Abschnitte erweitern, wenn vollständiger Kontext verfügbar ist. Nur Option pro Aufruf (kein Plugin-Standardschlüssel).
fileFormat
"png" | "pdf"
Gerendertes Dateiformat. Standardmäßig der Plugin-Standardwert defaults.fileFormat.
fileQuality
"standard" | "hq" | "print"
Qualitätsvorgabe für PNG- oder PDF-Rendering.
fileScale
number
Überschreibung der Geräteskalierung (1-4).
fileMaxWidth
number
Maximale Renderbreite in CSS-Pixeln (640-2400).
ttlSeconds
number
Standard:"1800"
Artefakt-TTL in Sekunden für Viewer- und eigenständige Dateiausgaben. Max. 21600.
baseUrl
string
Überschreibung des Viewer-URL-Ursprungs. Überschreibt Plugin viewerBaseUrl. Muss http oder https sein, keine Abfrage/kein Hash.
Aus Gründen der Abwärtskompatibilität weiterhin akzeptiert:
  • format -> fileFormat
  • imageFormat -> fileFormat
  • imageQuality -> fileQuality
  • imageScale -> fileScale
  • imageMaxWidth -> fileMaxWidth
  • before und after jeweils max. 512 KiB.
  • patch max. 2 MiB.
  • path max. 2048 Byte.
  • lang max. 128 Byte.
  • title max. 1024 Byte.
  • Obergrenze für Patch-Komplexität: max. 128 Dateien und insgesamt 120000 Zeilen.
  • patch zusammen mit before oder after wird abgelehnt.
  • Sicherheitsgrenzwerte für gerenderte Dateien (gelten für PNG und PDF):
    • fileQuality: "standard": max. 8 MP (8.000.000 gerenderte Pixel).
    • fileQuality: "hq": max. 14 MP (14.000.000 gerenderte Pixel).
    • fileQuality: "print": max. 24 MP (24.000.000 gerenderte Pixel).
    • PDF hat außerdem ein Maximum von 50 Seiten.

Vertrag für Ausgabedetails

Das Tool gibt strukturierte Metadaten unter details zurück.
Gemeinsame Felder für Modi, die einen Viewer erstellen:
  • artifactId
  • viewerUrl
  • viewerPath
  • title
  • expiresAt
  • inputKind
  • fileCount
  • mode
  • context (agentId, sessionId, messageChannel, agentAccountId, wenn verfügbar)
Dateifelder, wenn PNG oder PDF gerendert wird:
  • artifactId
  • expiresAt
  • filePath
  • path (derselbe Wert wie filePath, für Kompatibilität mit dem message-Tool)
  • fileBytes
  • fileFormat
  • fileQuality
  • fileScale
  • fileMaxWidth
Für bestehende Aufrufer ebenfalls zurückgegeben:
  • format (derselbe Wert wie fileFormat)
  • imagePath (derselbe Wert wie filePath)
  • imageBytes (derselbe Wert wie fileBytes)
  • imageQuality (derselbe Wert wie fileQuality)
  • imageScale (derselbe Wert wie fileScale)
  • imageMaxWidth (derselbe Wert wie fileMaxWidth)
Zusammenfassung des Modusverhaltens:
ModusWas zurückgegeben wird
"view"Nur Viewer-Felder.
"file"Nur Dateifelder, kein Viewer-Artefakt.
"both"Viewer-Felder plus Dateifelder. Wenn das Datei-Rendering fehlschlägt, wird der Viewer dennoch mit fileError und dem Alias imageError zurückgegeben.

Eingeklappte unveränderte Abschnitte

  • Der Viewer kann Zeilen wie N unmodified lines anzeigen.
  • Erweiterungssteuerelemente in diesen Zeilen sind bedingt und nicht für jede Eingabeart garantiert.
  • Erweiterungssteuerelemente erscheinen, wenn der gerenderte Diff erweiterbare Kontextdaten enthält, was für Vorher-und-nachher-Eingaben typisch ist.
  • Bei vielen vereinheitlichten Patch-Eingaben sind ausgelassene Kontextkörper in den geparsten Patch-Hunks nicht verfügbar, sodass die Zeile ohne Erweiterungssteuerelemente erscheinen kann. Dies ist erwartetes Verhalten.
  • expandUnchanged gilt nur, wenn erweiterbarer Kontext vorhanden ist.

Plugin-Standardwerte

Legen Sie Plugin-weite Standardwerte in ~/.openclaw/openclaw.json fest:
{
  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,
          },
        },
      },
    },
  },
}
Unterstützte Standardwerte:
  • fontFamily
  • fontSize
  • lineSpacing
  • layout
  • showLineNumbers
  • diffIndicators
  • wordWrap
  • background
  • theme
  • fileFormat
  • fileQuality
  • fileScale
  • fileMaxWidth
  • mode
  • ttlSeconds
Explizite Tool-Parameter überschreiben diese Standardwerte.

Persistente Viewer-URL-Konfiguration

viewerBaseUrl
string
Plugin-eigene Rückfalloption für zurückgegebene Viewer-Links, wenn ein Tool-Aufruf baseUrl nicht übergibt. Muss http oder https sein, keine Abfrage/kein Hash.
{
  plugins: {
    entries: {
      diffs: {
        enabled: true,
        config: {
          viewerBaseUrl: "https://gateway.example.com/openclaw",
        },
      },
    },
  },
}

Sicherheitskonfiguration

security.allowRemoteViewer
boolean
Standard:"false"
false: Nicht-local-loopback-Anfragen an Viewer-Routen werden verweigert. true: Remote-Viewer sind erlaubt, wenn der tokenisierte Pfad gültig ist.
{
  plugins: {
    entries: {
      diffs: {
        enabled: true,
        config: {
          security: {
            allowRemoteViewer: false,
          },
        },
      },
    },
  },
}

Artefaktlebenszyklus und Speicherung

  • Artefakte werden im temporären Unterordner gespeichert: $TMPDIR/openclaw-diffs.
  • Viewer-Artefaktmetadaten enthalten:
    • zufällige Artefakt-ID (20 Hex-Zeichen)
    • zufälliges Token (48 Hex-Zeichen)
    • createdAt und expiresAt
    • gespeicherter viewer.html-Pfad
  • Die standardmäßige Artefakt-TTL beträgt 30 Minuten, wenn sie nicht angegeben wird.
  • Die maximal akzeptierte Viewer-TTL beträgt 6 Stunden.
  • Die Bereinigung wird nach der Artefakterstellung opportunistisch ausgeführt.
  • Abgelaufene Artefakte werden gelöscht.
  • Die Rückfallbereinigung entfernt veraltete Ordner, die älter als 24 Stunden sind, wenn Metadaten fehlen.

Viewer-URL und Netzwerkverhalten

Viewer-Route:
  • /plugins/diffs/view/{artifactId}/{token}
Viewer-Assets:
  • /plugins/diffs/assets/viewer.js
  • /plugins/diffs/assets/viewer-runtime.js
Das Viewer-Dokument löst diese Assets relativ zur Viewer-URL auf, sodass ein optionales baseUrl-Pfadpräfix auch für beide Asset-Anfragen beibehalten wird. URL-Konstruktionsverhalten:
  • Wenn Tool-Aufruf-baseUrl angegeben ist, wird es nach strenger Validierung verwendet.
  • Andernfalls, wenn Plugin viewerBaseUrl konfiguriert ist, wird es verwendet.
  • Ohne eine der beiden Überschreibungen ist die Viewer-URL standardmäßig local loopback 127.0.0.1.
  • Wenn der Gateway-Bind-Modus custom ist und gateway.customBindHost gesetzt ist, wird dieser Host verwendet.
baseUrl-Regeln:
  • Muss http:// oder https:// sein.
  • Abfrage und Hash werden abgelehnt.
  • Ursprung plus optionaler Basispfad ist erlaubt.

Sicherheitsmodell

  • Standardmäßig nur Loopback.
  • Tokenisierte Viewer-Pfade mit strenger ID- und Token-Validierung.
  • CSP für Viewer-Antworten:
    • default-src 'none'
    • Skripte und Assets nur von derselben Quelle
    • kein ausgehendes connect-src
  • Drosselung von Remote-Fehlversuchen, wenn Remote-Zugriff aktiviert ist:
    • 40 Fehlversuche pro 60 Sekunden
    • 60 Sekunden Sperre (429 Too Many Requests)
  • Das Routing von Screenshot-Browseranfragen ist standardmäßig verweigernd.
  • Nur lokale Viewer-Assets von http://127.0.0.1/plugins/diffs/assets/* sind erlaubt.
  • Externe Netzwerkanfragen werden blockiert.

Browseranforderungen für den Dateimodus

mode: "file" und mode: "both" benötigen einen Chromium-kompatiblen Browser. Auflösungsreihenfolge:
1

Konfiguration

browser.executablePath in der OpenClaw-Konfiguration.
2

Umgebungsvariablen

  • OPENCLAW_BROWSER_EXECUTABLE_PATH
  • BROWSER_EXECUTABLE_PATH
  • PLAYWRIGHT_CHROMIUM_EXECUTABLE_PATH
3

Plattform-Fallback

Fallback für plattformspezifische Befehls-/Pfaderkennung.
Häufiger Fehlertext:
  • Diff PNG/PDF rendering requires a Chromium-compatible browser...
Beheben Sie dies, indem Sie Chrome, Chromium, Edge oder Brave installieren oder eine der oben genannten Optionen für den ausführbaren Pfad festlegen.

Fehlerbehebung

  • Provide patch or both before and after text. — geben Sie sowohl before als auch after an, oder geben Sie patch an.
  • Provide either patch or before/after input, not both. — mischen Sie die Eingabemodi nicht.
  • Invalid baseUrl: ... — verwenden Sie einen http(s)-Ursprung mit optionalem Pfad, ohne Query/Hash.
  • {field} exceeds maximum size (...) — reduzieren Sie die Payload-Größe.
  • Ablehnung großer Patches — reduzieren Sie die Anzahl der Patch-Dateien oder die Gesamtzahl der Zeilen.
  • Die Viewer-URL wird standardmäßig zu 127.0.0.1 aufgelöst.
  • Für Remote-Zugriffsszenarien entweder:
    • Plugin-viewerBaseUrl festlegen, oder
    • baseUrl pro Tool-Aufruf übergeben, oder
    • gateway.bind=custom und gateway.customBindHost verwenden
  • Wenn gateway.trustedProxies Loopback für einen Proxy auf demselben Host enthält (zum Beispiel Tailscale Serve), schlagen rohe Loopback-Viewer-Anfragen ohne weitergeleitete Client-IP-Header absichtlich geschlossen fehl.
  • Für diese Proxy-Topologie:
    • bevorzugen Sie mode: "file" oder mode: "both", wenn Sie nur einen Anhang benötigen, oder
    • aktivieren Sie bewusst security.allowRemoteViewer und legen Sie Plugin-viewerBaseUrl fest oder übergeben Sie eine Proxy-/öffentliche baseUrl, wenn Sie eine teilbare Viewer-URL benötigen
  • Aktivieren Sie security.allowRemoteViewer nur, wenn Sie externen Viewer-Zugriff beabsichtigen.
Dies kann bei Patch-Eingaben passieren, wenn der Patch keinen erweiterbaren Kontext enthält. Dies ist erwartet und deutet nicht auf einen Viewer-Fehler hin.
  • Artefakt ist aufgrund der TTL abgelaufen.
  • Token oder Pfad wurde geändert.
  • Bereinigung hat veraltete Daten entfernt.

Betriebliche Hinweise

  • Bevorzugen Sie mode: "view" für lokale interaktive Reviews in Canvas.
  • Bevorzugen Sie mode: "file" für ausgehende Chat-Kanäle, die einen Anhang benötigen.
  • Lassen Sie allowRemoteViewer deaktiviert, sofern Ihre Bereitstellung keine Remote-Viewer-URLs erfordert.
  • Legen Sie für vertrauliche Diffs explizit kurze ttlSeconds fest.
  • Vermeiden Sie es, Geheimnisse in Diff-Eingaben zu senden, wenn dies nicht erforderlich ist.
  • Wenn Ihr Kanal Bilder stark komprimiert (zum Beispiel Telegram oder WhatsApp), bevorzugen Sie PDF-Ausgabe (fileFormat: "pdf").
Diff-Rendering-Engine bereitgestellt von Diffs.

Verwandt