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 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- enafter-tekst- een uniforme
patch
- een Gateway-viewer-URL voor canvaspresentatie
- een gerenderd bestandspad (PNG of PDF) voor berichtbezorging
- beide uitvoeritems in één aanroep
Snel aan de slag
Ingebouwde systeemrichtlijnen uitschakelen
Als je dediffs-tool ingeschakeld wilt houden maar de ingebouwde systeempromptrichtlijnen wilt uitschakelen, stel je plugins.entries.diffs.hooks.allowPromptInjection in op false:
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 and after
- Patch
Referentie voor toolinvoer
Alle velden zijn optioneel tenzij anders vermeld.Originele tekst. Vereist met
after wanneer patch is weggelaten.Bijgewerkte tekst. Vereist met
before wanneer patch is weggelaten.Uniforme difftekst. Wederzijds uitsluitend met
before en after.Weergavebestandsnaam voor de modus voor voor en na.
Hint voor taaloverschrijving voor de modus voor voor en na. Onbekende waarden vallen terug op platte tekst.
Overschrijving van viewertitel.
Uitvoermodus. Standaard ingesteld op Plugin-standaard
defaults.mode. Verouderde alias: "image" gedraagt zich als "file" en wordt nog steeds geaccepteerd voor achterwaartse compatibiliteit.Viewerthema. Standaard ingesteld op Plugin-standaard
defaults.theme.Diffindeling. Standaard ingesteld op Plugin-standaard
defaults.layout.Vouw ongewijzigde secties uit wanneer volledige context beschikbaar is. Alleen optie per aanroep (geen Plugin-standaardsleutel).
Gerenderde bestandsindeling. Standaard ingesteld op Plugin-standaard
defaults.fileFormat.Kwaliteitsvoorinstelling 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 bestandsuitvoer. Max. 21600.
Overschrijving van oorsprong voor viewer-URL. Overschrijft Plugin
viewerBaseUrl. Moet http of https zijn, zonder query/hash.Legacy input aliases
Legacy input aliases
Wordt nog steeds geaccepteerd voor achterwaartse compatibiliteit:
format->fileFormatimageFormat->fileFormatimageQuality->fileQualityimageScale->fileScaleimageMaxWidth->fileMaxWidth
Validation and limits
Validation and limits
beforeenafterelk max. 512 KiB.patchmax. 2 MiB.pathmax. 2048 bytes.langmax. 128 bytes.titlemax. 1024 bytes.- Complexiteitslimiet voor patches: max. 128 bestanden en 120000 totale regels.
patchsamen metbeforeofafterwordt 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 daarnaast een maximum van 50 pagina’s.
Contract voor uitvoerdetails
De tool retourneert gestructureerde metadata onderdetails.
Viewer fields
Viewer fields
Gedeelde velden voor modi die een viewer maken:
artifactIdviewerUrlviewerPathtitleexpiresAtinputKindfileCountmodecontext(agentId,sessionId,messageChannel,agentAccountIdwanneer beschikbaar)
File fields
File fields
Bestandsvelden wanneer PNG of PDF wordt gerenderd:
artifactIdexpiresAtfilePathpath(dezelfde waarde alsfilePath, voor compatibiliteit met de berichttool)fileBytesfileFormatfileQualityfileScalefileMaxWidth
Compatibility aliases
Compatibility aliases
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 alias imageError. |
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.
expandUnchangedis alleen van toepassing wanneer uitbreidbare context bestaat.
Plugin-standaarden
Stel Plugin-brede standaarden in~/.openclaw/openclaw.json in:
fontFamilyfontSizelineSpacinglayoutshowLineNumbersdiffIndicatorswordWrapbackgroundthemefileFormatfileQualityfileScalefileMaxWidthmode
Persistente configuratie voor viewer-URL
Terugval van de Plugin voor geretourneerde viewerlinks wanneer een toolaanroep 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.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)
createdAtenexpiresAt- 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}
/plugins/diffs/assets/viewer.js/plugins/diffs/assets/viewer-runtime.js
baseUrl-padvoorvoegsel ook voor beide assetaanvragen behouden blijft.
URL-constructiegedrag:
- Als
baseUrlvan de toolaanroep is opgegeven, wordt deze gebruikt na strikte validatie. - Anders, als Plugin
viewerBaseUrlis 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
customis engateway.customBindHostis ingesteld, wordt die host gebruikt.
baseUrl-regels:
- Moet
http://ofhttps://zijn. - Query en hash worden geweigerd.
- Oorsprong plus optioneel basispad is toegestaan.
Beveiligingsmodel
Viewer-verharding
Viewer-verharding
- Standaard alleen loopback.
- Getokeniseerde viewerpaden met strikte ID- en tokenvalidatie.
- CSP voor viewerrespons:
default-src 'none'- scripts en assets alleen van self
- geen uitgaande
connect-src
- Throttling van externe missers wanneer externe toegang is ingeschakeld:
- 40 mislukkingen per 60 seconden
- lock-out van 60 seconden (
429 Too Many Requests)
Verharding van bestandsweergave
Verharding van bestandsweergave
- Routering van screenshotbrowserverzoeken is standaard-weigeren.
- Alleen lokale viewerassets van
http://127.0.0.1/plugins/diffs/assets/*zijn toegestaan. - Externe netwerkverzoeken 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 geen invoermodi.Invalid baseUrl: ...— gebruik eenhttp(s)-origin met optioneel pad, zonder query/hash.{field} exceeds maximum size (...)— verklein de payloadgrootte.- Weigering van grote patch — verminder het aantal patchbestanden of het totale aantal regels.
Toegankelijkheid van viewer
Toegankelijkheid van viewer
- De viewer-URL wordt standaard omgezet naar
127.0.0.1. - Voor scenario’s met externe toegang:
- stel Plugin
viewerBaseUrlin, of - geef
baseUrlper toolaanroep door, of - gebruik
gateway.bind=customengateway.customBindHost
- stel Plugin
- Als
gateway.trustedProxiesloopback bevat voor een proxy op dezelfde host (bijvoorbeeld Tailscale Serve), mislukken ruwe loopback-viewerverzoeken zonder doorgestuurde client-IP-headers bewust gesloten. - 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/openbarebaseUrldoor wanneer je een deelbare viewer-URL nodig hebt
- geef de voorkeur aan
- Schakel
security.allowRemoteVieweralleen in wanneer je externe viewertoegang wilt.
Rij met ongewijzigde regels heeft geen uitvouwknop
Rij met ongewijzigde regels heeft geen uitvouwknop
Dit kan gebeuren bij patchinvoer wanneer de patch geen uitvouwbare context bevat. Dit is verwacht en duidt niet op een viewerfout.
Artefact niet gevonden
Artefact niet gevonden
- Artefact verlopen vanwege TTL.
- Token of pad gewijzigd.
- Opschoning heeft verouderde gegevens 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 implementatie externe viewer-URL’s vereist. - Stel expliciete korte
ttlSecondsin 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").
Diff-renderingengine aangedreven door Diffs.