Documentation Index
Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt
Use this file to discover all available pages before exploring further.
diffs is een optioneel Plugin-hulpmiddel met korte ingebouwde systeemrichtlijnen en een bijbehorende skill die wijzigingsinhoud omzet in een alleen-lezen diff-artefact voor agents.
Het accepteert een van de volgende opties:
before- enafter-tekst- een uniforme
patch
- een Gateway-viewer-URL voor canvas-presentatie
- een gerenderd bestandspad (PNG of PDF) voor berichtbezorging
- beide outputs in een enkele aanroep
Snel starten
Ingebouwde systeemrichtlijnen uitschakelen
Als je hetdiffs-hulpmiddel ingeschakeld wilt houden maar de ingebouwde systeem-prompt-richtlijnen wilt uitschakelen, stel je plugins.entries.diffs.hooks.allowPromptInjection in op false:
before_prompt_build-hook van de diffs-Plugin, terwijl de Plugin, het hulpmiddel en de bijbehorende skill beschikbaar blijven.
Als je zowel de richtlijnen als het hulpmiddel wilt uitschakelen, schakel dan in plaats daarvan de Plugin uit.
Typische agentworkflow
Invoervoorbeelden
- Voor en na
- Patch
Referentie voor hulpmiddelinvoer
Alle velden zijn optioneel, tenzij anders vermeld.Oorspronkelijke tekst. Vereist met
after wanneer patch is weggelaten.Bijgewerkte tekst. Vereist met
before wanneer patch is weggelaten.Uniforme diff-tekst. Wederzijds uitsluitend met
before en after.Weergavebestandsnaam voor de voor-en-na-modus.
Hint voor taaloverschrijving voor de voor-en-na-modus. Onbekende waarden vallen terug op platte tekst.
Overschrijving van viewertitel.
Uitvoermodus. Standaard is de Plugin-standaard
defaults.mode. Verouderde alias: "image" gedraagt zich als "file" en wordt nog steeds geaccepteerd voor achterwaartse compatibiliteit.Viewerthema. Standaard is de Plugin-standaard
defaults.theme.Diff-indeling. Standaard is de Plugin-standaard
defaults.layout.Vouw ongewijzigde secties uit wanneer volledige context beschikbaar is. Alleen optie per aanroep (geen Plugin-standaardsleutel).
Gerenderde bestandsindeling. Standaard is de Plugin-standaard
defaults.fileFormat.Kwaliteitspreset voor PNG- of PDF-rendering.
Overschrijving van apparaatschaal (
1-4).Maximale renderbreedte in CSS-pixels (
640-2400).Artefact-TTL in seconden voor viewer- en zelfstandige bestandsoutputs. Max 21600.
Overschrijving van viewer-URL-origin. Overschrijft Plugin
viewerBaseUrl. Moet http of https zijn, zonder query/hash.Verouderde invoeraliassen
Verouderde invoeraliassen
Nog steeds geaccepteerd voor achterwaartse compatibiliteit:
format->fileFormatimageFormat->fileFormatimageQuality->fileQualityimageScale->fileScaleimageMaxWidth->fileMaxWidth
Validatie en limieten
Validatie en limieten
beforeenafterelk max 512 KiB.patchmax 2 MiB.pathmax 2048 bytes.langmax 128 bytes.titlemax 1024 bytes.- Limiet voor patchcomplexiteit: max 128 bestanden en 120000 totale regels.
patchenbeforeofaftersamen worden geweigerd.- Veiligheidslimieten voor gerenderde bestanden (van toepassing op PNG en PDF):
fileQuality: "standard": max 8 MP (8.000.000 gerenderde pixels).fileQuality: "hq": max 14 MP (14.000.000 gerenderde pixels).fileQuality: "print": max 24 MP (24.000.000 gerenderde pixels).- PDF heeft ook een maximum van 50 pagina’s.
Contract voor outputdetails
Het hulpmiddel retourneert gestructureerde metadata onderdetails.
Viewervelden
Viewervelden
Gedeelde velden voor modi die een viewer maken:
artifactIdviewerUrlviewerPathtitleexpiresAtinputKindfileCountmodecontext(agentId,sessionId,messageChannel,agentAccountIdwanneer beschikbaar)
Bestandsvelden
Bestandsvelden
Bestandsvelden wanneer PNG of PDF wordt gerenderd:
artifactIdexpiresAtfilePathpath(dezelfde waarde alsfilePath, voor compatibiliteit met bericht-hulpmiddelen)fileBytesfileFormatfileQualityfileScalefileMaxWidth
Compatibiliteitsaliassen
Compatibiliteitsaliassen
Ook geretourneerd voor bestaande aanroepers:
format(dezelfde waarde alsfileFormat)imagePath(dezelfde waarde alsfilePath)imageBytes(dezelfde waarde alsfileBytes)imageQuality(dezelfde waarde alsfileQuality)imageScale(dezelfde waarde alsfileScale)imageMaxWidth(dezelfde waarde alsfileMaxWidth)
| Modus | Wat wordt geretourneerd |
|---|---|
"view" | Alleen viewervelden. |
"file" | Alleen bestandsvelden, geen viewerartefact. |
"both" | Viewervelden plus bestandsvelden. Als bestandsrendering mislukt, wordt de viewer nog steeds geretourneerd met fileError en de alias imageError. |
Samengevouwen ongewijzigde secties
- De viewer kan rijen tonen zoals
N unmodified lines. - Uitvouwknoppen op die rijen zijn voorwaardelijk en niet gegarandeerd voor elk invoertype.
- Uitvouwknoppen verschijnen wanneer de gerenderde diff uitbreidbare contextgegevens heeft, wat typisch is voor voor-en-na-invoer.
- Voor veel uniforme patch-invoer zijn weggelaten contextinhouden niet beschikbaar in de geparste patch-hunks, zodat de rij zonder uitvouwknoppen kan verschijnen. Dit is verwacht gedrag.
expandUnchangedis alleen van toepassing wanneer uitbreidbare context bestaat.
Plugin-standaarden
Stel Plugin-brede standaarden in~/.openclaw/openclaw.json in:
fontFamilyfontSizelineSpacinglayoutshowLineNumbersdiffIndicatorswordWrapbackgroundthemefileFormatfileQualityfileScalefileMaxWidthmodettlSeconds
Configuratie voor persistente viewer-URL
Plugin-eigen fallback voor geretourneerde viewerlinks wanneer een hulpmiddelaanroep geen
baseUrl doorgeeft. Moet http of https zijn, zonder query/hash.Beveiligingsconfiguratie
false: niet-loopback-aanvragen naar viewerroutes worden geweigerd. true: externe viewers zijn toegestaan als het pad met token geldig is.Artefactlevenscyclus en opslag
- Artefacten worden opgeslagen onder de tijdelijke submap:
$TMPDIR/openclaw-diffs. - Viewerartefactmetadata bevat:
- willekeurige artefact-ID (20 hex-tekens)
- willekeurige token (48 hex-tekens)
createdAtenexpiresAt- opgeslagen
viewer.html-pad
- Standaard artefact-TTL is 30 minuten wanneer niet opgegeven.
- Maximale geaccepteerde viewer-TTL is 6 uur.
- Opschoning wordt opportunistisch uitgevoerd na het maken van artefacten.
- Verlopen artefacten worden verwijderd.
- Fallback-opschoning verwijdert verouderde mappen ouder dan 24 uur wanneer metadata ontbreekt.
Viewer-URL en netwerkgedrag
Viewerroute:/plugins/diffs/view/{artifactId}/{token}
/plugins/diffs/assets/viewer.js/plugins/diffs/assets/viewer-runtime.js
baseUrl-padprefix ook voor beide assetaanvragen behouden blijft.
Gedrag voor URL-constructie:
- Als tool-call
baseUrlis opgegeven, wordt deze na strikte validatie gebruikt. - Anders, als Plugin
viewerBaseUrlis geconfigureerd, wordt deze gebruikt. - Zonder een van beide overschrijvingen valt de viewer-URL terug op loopback
127.0.0.1. - Als Gateway-bindmodus
customis engateway.customBindHostis ingesteld, wordt die host gebruikt.
baseUrl-regels:
- Moet
http://ofhttps://zijn. - Query en hash worden geweigerd.
- Origin plus optioneel basispad is toegestaan.
Beveiligingsmodel
Viewer-verharding
Viewer-verharding
- Standaard alleen loopback.
- Getokeniseerde viewer-paden met strikte ID- en tokenvalidatie.
- CSP voor viewer-respons:
default-src 'none'- scripts en assets alleen vanaf self
- geen uitgaande
connect-src
- Throttling van externe missers wanneer externe toegang is ingeschakeld:
- 40 fouten per 60 seconden
- 60 seconden lockout (
429 Too Many Requests)
Verharding van bestandsweergave
Verharding van bestandsweergave
- Routering van screenshot-browserrequests is standaard geweigerd.
- Alleen lokale viewer-assets vanaf
http://127.0.0.1/plugins/diffs/assets/*zijn toegestaan. - Externe netwerkrequests worden geblokkeerd.
Browservereisten voor bestandsmodus
mode: "file" en mode: "both" hebben een Chromium-compatibele browser nodig.
Volgorde van oplossing:
Omgevingsvariabelen
OPENCLAW_BROWSER_EXECUTABLE_PATHBROWSER_EXECUTABLE_PATHPLAYWRIGHT_CHROMIUM_EXECUTABLE_PATH
Diff PNG/PDF rendering requires a Chromium-compatible browser...
Probleemoplossing
Invoervalidatiefouten
Invoervalidatiefouten
Provide patch or both before and after text.— neem zowelbeforealsafterop, of geefpatchop.Provide either patch or before/after input, not both.— meng invoermodi niet.Invalid baseUrl: ...— gebruik eenhttp(s)-origin met optioneel pad, zonder query/hash.{field} exceeds maximum size (...)— verklein de payloadgrootte.- Afwijzing van grote patch — verminder het aantal patchbestanden of het totale aantal regels.
Toegankelijkheid van viewer
Toegankelijkheid van viewer
- De viewer-URL resolveert standaard naar
127.0.0.1. - Voor scenario’s met externe toegang:
- stel Plugin
viewerBaseUrlin, of - geef
baseUrlper toolaanroep mee, of - gebruik
gateway.bind=customengateway.customBindHost
- stel Plugin
- Als
gateway.trustedProxiesloopback bevat voor een proxy op dezelfde host (bijvoorbeeld Tailscale Serve), mislukken ruwe loopback-viewerrequests zonder doorgestuurde client-IP-headers bewust fail-closed. - Voor die proxytopologie:
- geef de voorkeur aan
mode: "file"ofmode: "both"wanneer je alleen een bijlage nodig hebt, of - schakel bewust
security.allowRemoteViewerin en stel PluginviewerBaseUrlin of geef een proxy-/publiekebaseUrlmee wanneer je een deelbare viewer-URL nodig hebt
- geef de voorkeur aan
- Schakel
security.allowRemoteVieweralleen in wanneer je externe viewertoegang bedoelt.
Rij met ongewijzigde regels heeft geen uitklapknop
Rij met ongewijzigde regels heeft geen uitklapknop
Dit kan gebeuren bij patchinvoer wanneer de patch geen uitbreidbare context bevat. Dit is verwacht en duidt niet op een viewerfout.
Artefact niet gevonden
Artefact niet gevonden
- Artefact verlopen door TTL.
- Token of pad gewijzigd.
- Opschoning heeft verouderde data verwijderd.
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
allowRemoteVieweruitgeschakeld tenzij je deployment externe viewer-URL’s vereist. - Stel expliciete korte
ttlSecondsin voor gevoelige diffs. - Vermijd het verzenden van geheimen in diff-invoer wanneer dat niet vereist is.
- Als je kanaal afbeeldingen agressief comprimeert (bijvoorbeeld Telegram of WhatsApp), geef dan de voorkeur aan PDF-uitvoer (
fileFormat: "pdf").
Diff-renderingengine mogelijk gemaakt door Diffs.