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 è uno strumento Plugin opzionale con brevi indicazioni di sistema integrate e una skill complementare che trasforma il contenuto delle modifiche in un artefatto diff di sola lettura per gli agenti.
Accetta alternativamente:
- testo
beforeeafter - una
patchunificata
- un URL del visualizzatore del Gateway per la presentazione su canvas
- un percorso di file renderizzato (PNG o PDF) per la consegna nei messaggi
- entrambi gli output in una sola chiamata
Avvio rapido
Disabilitare le indicazioni di sistema integrate
Se vuoi mantenere abilitato lo strumentodiffs ma disabilitare le sue indicazioni integrate per il prompt di sistema, imposta plugins.entries.diffs.hooks.allowPromptInjection su false:
before_prompt_build del Plugin diffs mantenendo disponibili il Plugin, lo strumento e la skill complementare.
Se vuoi disabilitare sia le indicazioni sia lo strumento, disabilita invece il Plugin.
Workflow tipico dell’agente
Esempi di input
- Prima e dopo
- Patch
Riferimento dell’input dello strumento
Tutti i campi sono opzionali salvo diversa indicazione.Testo originale. Richiesto con
after quando patch è omesso.Testo aggiornato. Richiesto con
before quando patch è omesso.Testo diff unificato. Mutuamente esclusivo con
before e after.Nome file visualizzato per la modalità prima e dopo.
Suggerimento di override della lingua per la modalità prima e dopo. I valori sconosciuti ripiegano sul testo semplice.
Override del titolo del visualizzatore.
Modalità di output. Il valore predefinito è il default del Plugin
defaults.mode. Alias deprecato: "image" si comporta come "file" ed è ancora accettato per compatibilità all’indietro.Tema del visualizzatore. Il valore predefinito è il default del Plugin
defaults.theme.Layout del diff. Il valore predefinito è il default del Plugin
defaults.layout.Espande le sezioni invariate quando è disponibile il contesto completo. Opzione solo per singola chiamata (non una chiave predefinita del Plugin).
Formato del file renderizzato. Il valore predefinito è il default del Plugin
defaults.fileFormat.Preset di qualità per il rendering PNG o PDF.
Override della scala del dispositivo (
1-4).Larghezza massima di rendering in pixel CSS (
640-2400).TTL dell’artefatto in secondi per gli output del visualizzatore e dei file autonomi. Massimo 21600.
Override dell’origine dell’URL del visualizzatore. Sovrascrive
viewerBaseUrl del Plugin. Deve essere http o https, senza query/hash.Alias di input legacy
Alias di input legacy
Ancora accettati per compatibilità all’indietro:
format->fileFormatimageFormat->fileFormatimageQuality->fileQualityimageScale->fileScaleimageMaxWidth->fileMaxWidth
Convalida e limiti
Convalida e limiti
beforeeaftermassimo 512 KiB ciascuno.patchmassimo 2 MiB.pathmassimo 2048 byte.langmassimo 128 byte.titlemassimo 1024 byte.- Limite di complessità della patch: massimo 128 file e 120000 righe totali.
patchinsieme abeforeoafterviene rifiutato.- Limiti di sicurezza del file renderizzato (applicati a PNG e PDF):
fileQuality: "standard": massimo 8 MP (8.000.000 pixel renderizzati).fileQuality: "hq": massimo 14 MP (14.000.000 pixel renderizzati).fileQuality: "print": massimo 24 MP (24.000.000 pixel renderizzati).- Il PDF ha anche un massimo di 50 pagine.
Contratto dei dettagli di output
Lo strumento restituisce metadati strutturati sottodetails.
Campi del visualizzatore
Campi del visualizzatore
Campi condivisi per le modalità che creano un visualizzatore:
artifactIdviewerUrlviewerPathtitleexpiresAtinputKindfileCountmodecontext(agentId,sessionId,messageChannel,agentAccountIdquando disponibili)
Campi del file
Campi del file
Campi del file quando viene renderizzato PNG o PDF:
artifactIdexpiresAtfilePathpath(stesso valore difilePath, per compatibilità con lo strumento messaggi)fileBytesfileFormatfileQualityfileScalefileMaxWidth
Alias di compatibilità
Alias di compatibilità
Restituiti anche per i chiamanti esistenti:
format(stesso valore difileFormat)imagePath(stesso valore difilePath)imageBytes(stesso valore difileBytes)imageQuality(stesso valore difileQuality)imageScale(stesso valore difileScale)imageMaxWidth(stesso valore difileMaxWidth)
| Modalità | Cosa viene restituito |
|---|---|
"view" | Solo i campi del visualizzatore. |
"file" | Solo i campi del file, senza artefatto del visualizzatore. |
"both" | Campi del visualizzatore più campi del file. Se il rendering del file fallisce, il visualizzatore viene comunque restituito con fileError e l’alias imageError. |
Sezioni invariate compresse
- Il visualizzatore può mostrare righe come
N unmodified lines. - I controlli di espansione su quelle righe sono condizionali e non garantiti per ogni tipo di input.
- I controlli di espansione compaiono quando il diff renderizzato dispone di dati di contesto espandibili, cosa tipica per l’input prima e dopo.
- Per molti input patch unificati, i corpi del contesto omessi non sono disponibili negli hunk della patch analizzata, quindi la riga può apparire senza controlli di espansione. Questo è il comportamento previsto.
expandUnchangedsi applica solo quando esiste contesto espandibile.
Default del Plugin
Imposta i default a livello di Plugin in~/.openclaw/openclaw.json:
fontFamilyfontSizelineSpacinglayoutshowLineNumbersdiffIndicatorswordWrapbackgroundthemefileFormatfileQualityfileScalefileMaxWidthmodettlSeconds
Configurazione persistente dell’URL del visualizzatore
Fallback di proprietà del Plugin per i link del visualizzatore restituiti quando una chiamata allo strumento non passa
baseUrl. Deve essere http o https, senza query/hash.Configurazione di sicurezza
false: le richieste non loopback alle route del visualizzatore sono negate. true: i visualizzatori remoti sono consentiti se il percorso tokenizzato è valido.Ciclo di vita e archiviazione degli artefatti
- Gli artefatti sono archiviati nella sottocartella temporanea:
$TMPDIR/openclaw-diffs. - I metadati dell’artefatto del visualizzatore contengono:
- ID artefatto casuale (20 caratteri esadecimali)
- token casuale (48 caratteri esadecimali)
createdAteexpiresAt- percorso
viewer.htmlarchiviato
- Il TTL predefinito dell’artefatto è 30 minuti quando non specificato.
- Il TTL massimo accettato del visualizzatore è 6 ore.
- La pulizia viene eseguita opportunisticamente dopo la creazione dell’artefatto.
- Gli artefatti scaduti vengono eliminati.
- La pulizia di fallback rimuove le cartelle obsolete più vecchie di 24 ore quando i metadati mancano.
URL del visualizzatore e comportamento di rete
Route del visualizzatore:/plugins/diffs/view/{artifactId}/{token}
/plugins/diffs/assets/viewer.js/plugins/diffs/assets/viewer-runtime.js
baseUrl opzionale viene preservato anche per entrambe le richieste degli asset.
Comportamento di costruzione dell’URL:
- Se viene fornito
baseUrlnella chiamata allo strumento, viene usato dopo una convalida rigorosa. - Altrimenti, se
viewerBaseUrldel Plugin è configurato, viene usato. - Senza nessuno dei due override, l’URL del visualizzatore usa per default il loopback
127.0.0.1. - Se la modalità di bind del Gateway è
customegateway.customBindHostè impostato, viene usato quell’host.
baseUrl:
- Deve essere
http://ohttps://. - Query e hash vengono rifiutati.
- È consentita l’origine più un percorso base opzionale.
Modello di sicurezza
Rafforzamento del visualizzatore
Rafforzamento del visualizzatore
- Solo loopback per impostazione predefinita.
- Percorsi del visualizzatore tokenizzati con convalida rigorosa di ID e token.
- CSP della risposta del visualizzatore:
default-src 'none'- script e asset solo da self
- nessun
connect-srcin uscita
- Limitazione dei miss remoti quando l’accesso remoto è abilitato:
- 40 errori ogni 60 secondi
- blocco di 60 secondi (
429 Too Many Requests)
Rafforzamento del rendering dei file
Rafforzamento del rendering dei file
- Il routing delle richieste del browser per gli screenshot è deny-by-default.
- Sono consentiti solo gli asset locali del visualizzatore da
http://127.0.0.1/plugins/diffs/assets/*. - Le richieste di rete esterne sono bloccate.
Requisiti del browser per la modalità file
mode: "file" e mode: "both" richiedono un browser compatibile con Chromium.
Ordine di risoluzione:
Variabili d'ambiente
OPENCLAW_BROWSER_EXECUTABLE_PATHBROWSER_EXECUTABLE_PATHPLAYWRIGHT_CHROMIUM_EXECUTABLE_PATH
Diff PNG/PDF rendering requires a Chromium-compatible browser...
Risoluzione dei problemi
Errori di convalida dell'input
Errori di convalida dell'input
Provide patch or both before and after text.— includi siabeforesiaafter, oppure forniscipatch.Provide either patch or before/after input, not both.— non combinare modalità di input.Invalid baseUrl: ...— usa un’originehttp(s)con percorso facoltativo, senza query/hash.{field} exceeds maximum size (...)— riduci la dimensione del payload.- Rifiuto di patch di grandi dimensioni — riduci il numero di file della patch o le righe totali.
Accessibilità del visualizzatore
Accessibilità del visualizzatore
- L’URL del visualizzatore si risolve in
127.0.0.1per impostazione predefinita. - Per scenari di accesso remoto:
- imposta
viewerBaseUrldel plugin, oppure - passa
baseUrlper ogni chiamata allo strumento, oppure - usa
gateway.bind=customegateway.customBindHost
- imposta
- Se
gateway.trustedProxiesinclude il loopback per un proxy sullo stesso host (per esempio Tailscale Serve), le richieste raw loopback al visualizzatore senza intestazioni client-IP inoltrate falliscono chiuse per progettazione. - Per quella topologia di proxy:
- preferisci
mode: "file"omode: "both"quando ti serve solo un allegato, oppure - abilita intenzionalmente
security.allowRemoteViewere impostaviewerBaseUrldel plugin o passa unbaseUrlproxy/pubblico quando ti serve un URL del visualizzatore condivisibile
- preferisci
- Abilita
security.allowRemoteViewersolo quando intendi consentire l’accesso esterno al visualizzatore.
La riga delle righe non modificate non ha pulsante di espansione
La riga delle righe non modificate non ha pulsante di espansione
Questo può accadere per l’input patch quando la patch non contiene contesto espandibile. È previsto e non indica un errore del visualizzatore.
Artefatto non trovato
Artefatto non trovato
- Artefatto scaduto a causa del TTL.
- Token o percorso modificati.
- La pulizia ha rimosso dati obsoleti.
Indicazioni operative
- Preferisci
mode: "view"per revisioni interattive locali in canvas. - Preferisci
mode: "file"per canali chat in uscita che richiedono un allegato. - Mantieni
allowRemoteViewerdisabilitato a meno che la tua distribuzione richieda URL remoti del visualizzatore. - Imposta
ttlSecondsbrevi ed espliciti per diff sensibili. - Evita di inviare segreti nell’input del diff quando non necessario.
- Se il tuo canale comprime le immagini in modo aggressivo (per esempio Telegram o WhatsApp), preferisci l’output PDF (
fileFormat: "pdf").
Motore di rendering dei diff powered by Diffs.