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 es una herramienta opcional de plugin con una guía de sistema integrada breve y una Skill complementaria que convierte el contenido de cambios en un artefacto diff de solo lectura para agentes.
Acepta cualquiera de estos elementos:
- texto
beforeyafter - un
patchunificado
- una URL de visor del Gateway para presentación en canvas
- una ruta de archivo renderizado (PNG o PDF) para entrega por mensaje
- ambas salidas en una sola llamada
Inicio rápido
Deshabilitar la guía de sistema integrada
Si quieres mantener habilitada la herramientadiffs pero deshabilitar su guía integrada de prompt de sistema, establece plugins.entries.diffs.hooks.allowPromptInjection en false:
before_prompt_build del plugin diffs y mantiene disponibles el plugin, la herramienta y la Skill complementaria.
Si quieres deshabilitar tanto la guía como la herramienta, deshabilita el plugin.
Flujo de trabajo típico del agente
Ejemplos de entrada
- Antes y después
- Patch
Referencia de entrada de la herramienta
Todos los campos son opcionales salvo que se indique lo contrario.Texto original. Obligatorio con
after cuando se omite patch.Texto actualizado. Obligatorio con
before cuando se omite patch.Texto diff unificado. Mutuamente excluyente con
before y after.Nombre de archivo mostrado para el modo antes y después.
Indicación de sobrescritura de idioma para el modo antes y después. Los valores desconocidos vuelven a texto sin formato.
Sobrescritura del título del visor.
Modo de salida. El valor predeterminado es el valor predeterminado del plugin
defaults.mode. Alias obsoleto: "image" se comporta como "file" y todavía se acepta por compatibilidad con versiones anteriores.Tema del visor. El valor predeterminado es el valor predeterminado del plugin
defaults.theme.Diseño del diff. El valor predeterminado es el valor predeterminado del plugin
defaults.layout.Expande secciones sin cambios cuando está disponible el contexto completo. Opción solo por llamada (no es una clave predeterminada del plugin).
Formato de archivo renderizado. El valor predeterminado es el valor predeterminado del plugin
defaults.fileFormat.Preajuste de calidad para renderizado PNG o PDF.
Sobrescritura de escala del dispositivo (
1-4).Anchura máxima de renderizado en píxeles CSS (
640-2400).TTL del artefacto en segundos para salidas de visor y de archivo independiente. Máximo 21600.
Sobrescritura del origen de la URL del visor. Sobrescribe
viewerBaseUrl del plugin. Debe ser http o https, sin consulta/hash.Alias de entrada heredados
Alias de entrada heredados
Todavía se aceptan por compatibilidad con versiones anteriores:
format->fileFormatimageFormat->fileFormatimageQuality->fileQualityimageScale->fileScaleimageMaxWidth->fileMaxWidth
Validación y límites
Validación y límites
beforeyaftertienen un máximo de 512 KiB cada uno.patchtiene un máximo de 2 MiB.pathtiene un máximo de 2048 bytes.langtiene un máximo de 128 bytes.titletiene un máximo de 1024 bytes.- Límite de complejidad de patch: máximo 128 archivos y 120000 líneas totales.
patchjunto conbeforeoafterse rechaza.- Límites de seguridad de archivos renderizados (se aplican a PNG y PDF):
fileQuality: "standard": máximo 8 MP (8,000,000 píxeles renderizados).fileQuality: "hq": máximo 14 MP (14,000,000 píxeles renderizados).fileQuality: "print": máximo 24 MP (24,000,000 píxeles renderizados).- PDF también tiene un máximo de 50 páginas.
Contrato de detalles de salida
La herramienta devuelve metadatos estructurados endetails.
Campos del visor
Campos del visor
Campos compartidos para modos que crean un visor:
artifactIdviewerUrlviewerPathtitleexpiresAtinputKindfileCountmodecontext(agentId,sessionId,messageChannel,agentAccountIdcuando están disponibles)
Campos de archivo
Campos de archivo
Campos de archivo cuando se renderiza PNG o PDF:
artifactIdexpiresAtfilePathpath(mismo valor quefilePath, para compatibilidad con la herramienta de mensajes)fileBytesfileFormatfileQualityfileScalefileMaxWidth
Alias de compatibilidad
Alias de compatibilidad
También se devuelven para llamadores existentes:
format(mismo valor quefileFormat)imagePath(mismo valor quefilePath)imageBytes(mismo valor quefileBytes)imageQuality(mismo valor quefileQuality)imageScale(mismo valor quefileScale)imageMaxWidth(mismo valor quefileMaxWidth)
| Modo | Qué se devuelve |
|---|---|
"view" | Solo campos del visor. |
"file" | Solo campos de archivo, sin artefacto de visor. |
"both" | Campos del visor más campos de archivo. Si falla el renderizado del archivo, el visor todavía se devuelve con el alias fileError e imageError. |
Secciones sin cambios contraídas
- El visor puede mostrar filas como
N unmodified lines. - Los controles de expansión en esas filas son condicionales y no están garantizados para cada tipo de entrada.
- Los controles de expansión aparecen cuando el diff renderizado tiene datos de contexto expandibles, lo cual es típico para entradas de antes y después.
- Para muchas entradas de patch unificado, los cuerpos de contexto omitidos no están disponibles en los hunks del patch analizado, por lo que la fila puede aparecer sin controles de expansión. Este es el comportamiento esperado.
expandUnchangedsolo se aplica cuando existe contexto expandible.
Valores predeterminados del plugin
Establece valores predeterminados para todo el plugin en~/.openclaw/openclaw.json:
fontFamilyfontSizelineSpacinglayoutshowLineNumbersdiffIndicatorswordWrapbackgroundthemefileFormatfileQualityfileScalefileMaxWidthmodettlSeconds
Configuración persistente de URL del visor
Alternativa de respaldo propia del plugin para enlaces de visor devueltos cuando una llamada de herramienta no pasa
baseUrl. Debe ser http o https, sin consulta/hash.Configuración de seguridad
false: se deniegan las solicitudes que no son loopback a rutas del visor. true: se permiten visores remotos si la ruta tokenizada es válida.Ciclo de vida y almacenamiento de artefactos
- Los artefactos se almacenan en la subcarpeta temporal:
$TMPDIR/openclaw-diffs. - Los metadatos de artefacto del visor contienen:
- ID de artefacto aleatorio (20 caracteres hexadecimales)
- token aleatorio (48 caracteres hexadecimales)
createdAtyexpiresAt- ruta
viewer.htmlalmacenada
- El TTL predeterminado del artefacto es de 30 minutos cuando no se especifica.
- El TTL máximo aceptado del visor es de 6 horas.
- La limpieza se ejecuta de forma oportunista después de la creación del artefacto.
- Los artefactos vencidos se eliminan.
- La limpieza de respaldo elimina carpetas obsoletas de más de 24 horas cuando faltan metadatos.
URL del visor y comportamiento de red
Ruta del visor:/plugins/diffs/view/{artifactId}/{token}
/plugins/diffs/assets/viewer.js/plugins/diffs/assets/viewer-runtime.js
baseUrl opcional para ambas solicitudes de recursos.
Comportamiento de construcción de URL:
- Si se proporciona
baseUrlen la llamada de herramienta, se usa después de una validación estricta. - De lo contrario, si
viewerBaseUrldel plugin está configurado, se usa. - Sin ninguna de las dos sobrescrituras, la URL del visor usa de forma predeterminada el loopback
127.0.0.1. - Si el modo de enlace del Gateway es
customygateway.customBindHostestá establecido, se usa ese host.
baseUrl:
- Debe ser
http://ohttps://. - Se rechazan consulta y hash.
- Se permite el origen más una ruta base opcional.
Modelo de seguridad
Refuerzo del visor
Refuerzo del visor
- Solo loopback de forma predeterminada.
- Rutas del visor con tokens y validación estricta de ID y token.
- CSP de respuesta del visor:
default-src 'none'- scripts y recursos solo desde self
- sin
connect-srcsaliente
- Limitación de fallos remotos cuando el acceso remoto está habilitado:
- 40 fallos por cada 60 segundos
- bloqueo de 60 segundos (
429 Too Many Requests)
Refuerzo de renderizado de archivos
Refuerzo de renderizado de archivos
- El enrutamiento de solicitudes del navegador de capturas de pantalla deniega de forma predeterminada.
- Solo se permiten recursos locales del visor desde
http://127.0.0.1/plugins/diffs/assets/*. - Las solicitudes de red externas están bloqueadas.
Requisitos del navegador para el modo de archivo
mode: "file" y mode: "both" necesitan un navegador compatible con Chromium.
Orden de resolución:
Variables de entorno
OPENCLAW_BROWSER_EXECUTABLE_PATHBROWSER_EXECUTABLE_PATHPLAYWRIGHT_CHROMIUM_EXECUTABLE_PATH
Diff PNG/PDF rendering requires a Chromium-compatible browser...
Solución de problemas
Errores de validación de entrada
Errores de validación de entrada
Provide patch or both before and after text.— incluye tantobeforecomoafter, o proporcionapatch.Provide either patch or before/after input, not both.— no mezcles modos de entrada.Invalid baseUrl: ...— usa un origenhttp(s)con ruta opcional, sin consulta/hash.{field} exceeds maximum size (...)— reduce el tamaño de la carga útil.- Rechazo de parche grande — reduce la cantidad de archivos del parche o el total de líneas.
Accesibilidad del visor
Accesibilidad del visor
- La URL del visor se resuelve a
127.0.0.1de forma predeterminada. - Para escenarios de acceso remoto, puedes:
- establecer
viewerBaseUrldel Plugin, o - pasar
baseUrlpor llamada de herramienta, o - usar
gateway.bind=customygateway.customBindHost
- establecer
- Si
gateway.trustedProxiesincluye loopback para un proxy en el mismo host (por ejemplo Tailscale Serve), las solicitudes sin procesar al visor por loopback sin encabezados de IP de cliente reenviados fallan cerradas por diseño. - Para esa topología de proxy:
- prefiere
mode: "file"omode: "both"cuando solo necesitas un adjunto, o - habilita intencionalmente
security.allowRemoteViewery estableceviewerBaseUrldel Plugin o pasa unbaseUrlde proxy/público cuando necesites una URL de visor compartible
- prefiere
- Habilita
security.allowRemoteViewersolo cuando tengas intención de permitir acceso externo al visor.
La fila de líneas sin modificar no tiene botón de expansión
La fila de líneas sin modificar no tiene botón de expansión
Esto puede ocurrir con la entrada de parche cuando el parche no contiene contexto expandible. Es esperado y no indica un fallo del visor.
Artefacto no encontrado
Artefacto no encontrado
- El artefacto expiró debido al TTL.
- El token o la ruta cambió.
- La limpieza eliminó datos obsoletos.
Guía operativa
- Prefiere
mode: "view"para revisiones interactivas locales en canvas. - Prefiere
mode: "file"para canales de chat salientes que necesitan un adjunto. - Mantén
allowRemoteViewerdeshabilitado salvo que tu despliegue requiera URL de visor remoto. - Establece
ttlSecondscortos explícitos para diffs sensibles. - Evita enviar secretos en la entrada de diff cuando no sea necesario.
- Si tu canal comprime imágenes de forma agresiva (por ejemplo Telegram o WhatsApp), prefiere la salida PDF (
fileFormat: "pdf").
Motor de renderizado de diff impulsado por Diffs.