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 est un outil de plugin facultatif avec de brèves consignes système intégrées et une Skill associée qui transforme le contenu des changements en artefact diff en lecture seule pour les agents.
Il accepte soit :
- du texte
beforeetafter - un
patchunifié
- une URL de visualiseur Gateway pour une présentation sur canvas
- un chemin de fichier rendu (PNG ou PDF) pour l’envoi par message
- les deux sorties dans un seul appel
Démarrage rapide
Désactiver les consignes système intégrées
Si vous souhaitez garder l’outildiffs activé mais désactiver ses consignes d’invite système intégrées, définissez plugins.entries.diffs.hooks.allowPromptInjection sur false :
before_prompt_build du plugin diffs tout en gardant le plugin, l’outil et la Skill associée disponibles.
Si vous souhaitez désactiver à la fois les consignes et l’outil, désactivez plutôt le plugin.
Flux de travail typique de l’agent
Exemples d’entrée
- Avant et après
- Patch
Référence des entrées de l’outil
Tous les champs sont facultatifs, sauf indication contraire.Texte d’origine. Requis avec
after lorsque patch est omis.Texte mis à jour. Requis avec
before lorsque patch est omis.Texte de diff unifié. Mutuellement exclusif avec
before et after.Nom de fichier affiché pour le mode avant et après.
Indice de remplacement de langue pour le mode avant et après. Les valeurs inconnues utilisent le texte brut par défaut.
Remplacement du titre du visualiseur.
Mode de sortie. Utilise par défaut la valeur par défaut du plugin
defaults.mode. Alias obsolète : "image" se comporte comme "file" et reste accepté pour la compatibilité descendante.Thème du visualiseur. Utilise par défaut la valeur par défaut du plugin
defaults.theme.Disposition du diff. Utilise par défaut la valeur par défaut du plugin
defaults.layout.Développer les sections inchangées lorsque le contexte complet est disponible. Option par appel uniquement (pas une clé par défaut du plugin).
Format du fichier rendu. Utilise par défaut la valeur par défaut du plugin
defaults.fileFormat.Préréglage de qualité pour le rendu PNG ou PDF.
Remplacement de l’échelle de l’appareil (
1-4).Largeur maximale de rendu en pixels CSS (
640-2400).TTL de l’artefact en secondes pour les sorties de visualiseur et de fichier autonome. Maximum 21600.
Remplacement de l’origine de l’URL du visualiseur. Remplace
viewerBaseUrl du plugin. Doit être http ou https, sans requête ni fragment.Alias d’entrée hérités
Alias d’entrée hérités
Toujours acceptés pour la compatibilité descendante :
format->fileFormatimageFormat->fileFormatimageQuality->fileQualityimageScale->fileScaleimageMaxWidth->fileMaxWidth
Validation et limites
Validation et limites
beforeetafteront chacun une taille maximale de 512 KiB.patcha une taille maximale de 2 MiB.patha une taille maximale de 2048 octets.langa une taille maximale de 128 octets.titlea une taille maximale de 1024 octets.- Plafond de complexité des patchs : maximum 128 fichiers et 120000 lignes au total.
patchavecbeforeouafterest rejeté.- Limites de sécurité des fichiers rendus (s’appliquent aux PNG et PDF) :
fileQuality: "standard": maximum 8 MP (8 000 000 pixels rendus).fileQuality: "hq": maximum 14 MP (14 000 000 pixels rendus).fileQuality: "print": maximum 24 MP (24 000 000 pixels rendus).- Le PDF a aussi un maximum de 50 pages.
Contrat des détails de sortie
L’outil renvoie des métadonnées structurées sousdetails.
Champs du visualiseur
Champs du visualiseur
Champs partagés pour les modes qui créent un visualiseur :
artifactIdviewerUrlviewerPathtitleexpiresAtinputKindfileCountmodecontext(agentId,sessionId,messageChannel,agentAccountIdlorsque disponible)
Champs de fichier
Champs de fichier
Champs de fichier lorsqu’un PNG ou un PDF est rendu :
artifactIdexpiresAtfilePathpath(même valeur quefilePath, pour la compatibilité avec l’outil de message)fileBytesfileFormatfileQualityfileScalefileMaxWidth
Alias de compatibilité
Alias de compatibilité
Également renvoyés pour les appelants existants :
format(même valeur quefileFormat)imagePath(même valeur quefilePath)imageBytes(même valeur quefileBytes)imageQuality(même valeur quefileQuality)imageScale(même valeur quefileScale)imageMaxWidth(même valeur quefileMaxWidth)
| Mode | Ce qui est renvoyé |
|---|---|
"view" | Champs du visualiseur uniquement. |
"file" | Champs de fichier uniquement, aucun artefact de visualiseur. |
"both" | Champs du visualiseur plus champs de fichier. Si le rendu du fichier échoue, le visualiseur est quand même renvoyé avec l’alias fileError et imageError. |
Sections inchangées repliées
- Le visualiseur peut afficher des lignes comme
N unmodified lines. - Les contrôles de développement sur ces lignes sont conditionnels et ne sont pas garantis pour chaque type d’entrée.
- Les contrôles de développement apparaissent lorsque le diff rendu contient des données de contexte développables, ce qui est typique pour une entrée avant et après.
- Pour de nombreuses entrées de patch unifié, les corps de contexte omis ne sont pas disponibles dans les hunks du patch analysé, donc la ligne peut apparaître sans contrôles de développement. Il s’agit du comportement attendu.
expandUnchangedne s’applique que lorsqu’un contexte développable existe.
Valeurs par défaut du plugin
Définissez les valeurs par défaut globales du plugin dans~/.openclaw/openclaw.json :
fontFamilyfontSizelineSpacinglayoutshowLineNumbersdiffIndicatorswordWrapbackgroundthemefileFormatfileQualityfileScalefileMaxWidthmodettlSeconds
Configuration d’URL de visualiseur persistante
Solution de repli détenue par le plugin pour les liens de visualiseur renvoyés lorsqu’un appel d’outil ne transmet pas
baseUrl. Doit être http ou https, sans requête ni fragment.Configuration de sécurité
false : les requêtes non-loopback vers les routes du visualiseur sont refusées. true : les visualiseurs distants sont autorisés si le chemin avec jeton est valide.Cycle de vie et stockage des artefacts
- Les artefacts sont stockés dans le sous-dossier temporaire :
$TMPDIR/openclaw-diffs. - Les métadonnées d’artefact du visualiseur contiennent :
- un ID d’artefact aléatoire (20 caractères hexadécimaux)
- un jeton aléatoire (48 caractères hexadécimaux)
createdAtetexpiresAt- le chemin
viewer.htmlstocké
- La TTL d’artefact par défaut est de 30 minutes lorsqu’elle n’est pas spécifiée.
- La TTL maximale acceptée pour le visualiseur est de 6 heures.
- Le nettoyage s’exécute de manière opportuniste après la création de l’artefact.
- Les artefacts expirés sont supprimés.
- Le nettoyage de repli supprime les dossiers obsolètes de plus de 24 heures lorsque les métadonnées sont absentes.
URL du visualiseur et comportement réseau
Route du visualiseur :/plugins/diffs/view/{artifactId}/{token}
/plugins/diffs/assets/viewer.js/plugins/diffs/assets/viewer-runtime.js
baseUrl facultatif est aussi conservé pour les deux requêtes de ressources.
Comportement de construction d’URL :
- Si
baseUrlde l’appel d’outil est fourni, il est utilisé après validation stricte. - Sinon, si
viewerBaseUrldu plugin est configuré, il est utilisé. - Sans aucun remplacement, l’URL du visualiseur utilise par défaut le loopback
127.0.0.1. - Si le mode de liaison du Gateway est
customet quegateway.customBindHostest défini, cet hôte est utilisé.
baseUrl :
- Doit être
http://ouhttps://. - La requête et le fragment sont rejetés.
- L’origine plus un chemin de base facultatif est autorisée.
Modèle de sécurité
Renforcement du visualiseur
Renforcement du visualiseur
- Local loopback uniquement par défaut.
- Chemins de visualiseur avec jeton, avec validation stricte de l’ID et du jeton.
- CSP de réponse du visualiseur :
default-src 'none'- scripts et ressources uniquement depuis la même origine
- aucun
connect-srcsortant
- Limitation des échecs distants lorsque l’accès distant est activé :
- 40 échecs par 60 secondes
- verrouillage de 60 secondes (
429 Too Many Requests)
Renforcement du rendu des fichiers
Renforcement du rendu des fichiers
- Le routage des requêtes du navigateur de capture d’écran refuse tout par défaut.
- Seules les ressources locales du visualiseur depuis
http://127.0.0.1/plugins/diffs/assets/*sont autorisées. - Les requêtes réseau externes sont bloquées.
Exigences de navigateur pour le mode fichier
mode: "file" et mode: "both" nécessitent un navigateur compatible avec Chromium.
Ordre de résolution :
Variables d’environnement
OPENCLAW_BROWSER_EXECUTABLE_PATHBROWSER_EXECUTABLE_PATHPLAYWRIGHT_CHROMIUM_EXECUTABLE_PATH
Diff PNG/PDF rendering requires a Chromium-compatible browser...
Dépannage
Erreurs de validation d’entrée
Erreurs de validation d’entrée
Provide patch or both before and after text.— incluez à la foisbeforeetafter, ou fournissezpatch.Provide either patch or before/after input, not both.— ne mélangez pas les modes d’entrée.Invalid baseUrl: ...— utilisez une originehttp(s)avec un chemin facultatif, sans requête ni fragment.{field} exceeds maximum size (...)— réduisez la taille de la charge utile.- Rejet d’un correctif volumineux — réduisez le nombre de fichiers du correctif ou le nombre total de lignes.
Accessibilité du visualiseur
Accessibilité du visualiseur
- L’URL du visualiseur se résout vers
127.0.0.1par défaut. - Pour les scénarios d’accès distant, vous pouvez :
- définir le
viewerBaseUrldu Plugin, ou - passer
baseUrlà chaque appel d’outil, ou - utiliser
gateway.bind=custometgateway.customBindHost
- définir le
- Si
gateway.trustedProxiesinclut le local loopback pour un proxy sur le même hôte (par exemple Tailscale Serve), les requêtes brutes du visualiseur en local loopback sans en-têtes d’IP client transférés échouent de manière fermée par conception. - Pour cette topologie de proxy :
- préférez
mode: "file"oumode: "both"lorsque vous avez seulement besoin d’une pièce jointe, ou - activez intentionnellement
security.allowRemoteVieweret définissez leviewerBaseUrldu Plugin ou passez unbaseUrlproxy/public lorsque vous avez besoin d’une URL de visualiseur partageable
- préférez
- Activez
security.allowRemoteVieweruniquement lorsque vous voulez permettre un accès externe au visualiseur.
La ligne des lignes non modifiées n’a pas de bouton de développement
La ligne des lignes non modifiées n’a pas de bouton de développement
Cela peut se produire pour une entrée de correctif lorsque le correctif ne contient pas de contexte développable. C’est attendu et cela n’indique pas un échec du visualiseur.
Artefact introuvable
Artefact introuvable
- L’artefact a expiré en raison de la TTL.
- Le jeton ou le chemin a changé.
- Le nettoyage a supprimé des données obsolètes.
Conseils opérationnels
- Préférez
mode: "view"pour les revues interactives locales dans le canevas. - Préférez
mode: "file"pour les canaux de discussion sortants qui nécessitent une pièce jointe. - Gardez
allowRemoteViewerdésactivé sauf si votre déploiement nécessite des URL de visualiseur distantes. - Définissez des
ttlSecondscourts explicites pour les diffs sensibles. - Évitez d’envoyer des secrets dans l’entrée de diff lorsque ce n’est pas nécessaire.
- Si votre canal compresse fortement les images (par exemple Telegram ou WhatsApp), préférez la sortie PDF (
fileFormat: "pdf").
Moteur de rendu de diff propulsé par Diffs.