Відмінності

diffs — це необов’язковий інструмент плагіна з короткими вбудованими системними настановами та супровідною навичкою, яка перетворює вміст змін на артефакт diff лише для читання для агентів.

Він приймає або:

• текст before і after
• уніфікований patch

Він може повернути:

• URL переглядача Gateway для презентації canvas
• шлях до відрендереного файлу (PNG або PDF) для доставки повідомлення
• обидва результати в одному виклику

Коли плагін увімкнено, він додає стислі настанови з використання до простору системного промпта, а також надає детальну навичку для випадків, коли агенту потрібні повніші інструкції.

Швидкий старт

openclaw plugins install diffs

{  plugins: {    entries: {      diffs: {        enabled: true,      },    },  },}

Вимкнення вбудованих системних настанов

Якщо потрібно залишити інструмент diffs увімкненим, але вимкнути його вбудовані настанови системного промпта, встановіть plugins.entries.diffs.hooks.allowPromptInjection у false:

{  plugins: {    entries: {      diffs: {        enabled: true,        hooks: {          allowPromptInjection: false,        },      },    },  },}

Це блокує хук before_prompt_build плагіна diffs, залишаючи плагін, інструмент і супровідну навичку доступними.

Якщо потрібно вимкнути і настанови, і інструмент, натомість вимкніть плагін.

Типовий робочий процес агента

Приклади вхідних даних

{  "before": "# Hello\n\nOne",  "after": "# Hello\n\nTwo",  "path": "docs/example.md",  "mode": "view"}

{  "patch": "diff --git a/src/example.ts b/src/example.ts\n--- a/src/example.ts\n+++ b/src/example.ts\n@@ -1 +1 @@\n-const x = 1;\n+const x = 2;\n",  "mode": "both"}

Довідник вхідних даних інструмента

Усі поля необов’язкові, якщо не зазначено інше.

Підсвічування синтаксису

OpenClaw містить підсвічування синтаксису для поширених мов вихідного коду, конфігурації та документації:

javascript, typescript, tsx, jsx, json, markdown, yaml, css, html, sh, python, go, rust, java, c, cpp, csharp, php, sql, docker, ruby, swift, kotlin, r, dart, lua, powershell, xml і toml.

Поширені псевдоніми, як-от js, ts, bash, md, yml, c++, dockerfile, rb, kt і ps1, нормалізуються до цих стандартних мов.

Установіть Plugin Diff Viewer Language Pack, щоб підсвічувати інші мови:

openclaw plugins install clawhub:@openclaw/diffs-language-pack

Коли мовний пакет доступний, OpenClaw може підсвічувати значно більше мов. Якщо пакет не встановлено, файли поза стандартним списком усе одно відображаються як читабельний звичайний текст. Приклади: Astro, Vue, Svelte, MDX, GraphQL, Terraform/HCL, Nix, Clojure, Elixir, Haskell, OCaml, Scala, Zig, Solidity, Verilog/VHDL, Fortran, MATLAB, LaTeX, Mermaid, Sass/Less/SCSS, Nginx, Apache, CSV, dotenv, INI та diff-файли.

Див. Plugin Diffs Language Pack для деталей і мови Shiki для upstream-каталогу мов і псевдонімів Shiki.

Контракт деталей виводу

Інструмент повертає структуровані метадані в details.

Підсумок поведінки режимів:

Згорнуті незмінені розділи

• Переглядач може показувати рядки на кшталт N unmodified lines.
• Елементи керування розгортанням у цих рядках є умовними й не гарантуються для кожного типу вхідних даних.
• Елементи керування розгортанням з’являються, коли відтворений diff має розгортані контекстні дані, що типово для вхідних даних до і після.
• Для багатьох вхідних даних unified patch пропущені тіла контексту недоступні в розібраних hunks патча, тому рядок може з’явитися без елементів керування розгортанням. Це очікувана поведінка.
• expandUnchanged застосовується лише тоді, коли існує розгортаний контекст.

Типові значення Plugin

Задайте типові значення для всього Plugin у ~/.openclaw/openclaw.json:

{  plugins: {    entries: {      diffs: {        enabled: true,        config: {          defaults: {            fontFamily: "Fira Code",            fontSize: 15,            lineSpacing: 1.6,            layout: "unified",            showLineNumbers: true,            diffIndicators: "bars",            wordWrap: true,            background: true,            theme: "dark",            fileFormat: "png",            fileQuality: "standard",            fileScale: 2,            fileMaxWidth: 960,            mode: "both",            ttlSeconds: 21600,          },        },      },    },  },}

Підтримувані типові значення:

• fontFamily
• fontSize
• lineSpacing
• layout
• showLineNumbers
• diffIndicators
• wordWrap
• background
• theme
• fileFormat
• fileQuality
• fileScale
• fileMaxWidth
• mode
• ttlSeconds

Явні параметри інструмента перевизначають ці типові значення.

Конфігурація постійної URL-адреси переглядача

{  plugins: {    entries: {      diffs: {        enabled: true,        config: {          viewerBaseUrl: "https://gateway.example.com/openclaw",        },      },    },  },}

Конфігурація безпеки

{  plugins: {    entries: {      diffs: {        enabled: true,        config: {          security: {            allowRemoteViewer: false,          },        },      },    },  },}

Життєвий цикл і зберігання артефактів

• Артефакти зберігаються в тимчасовій підпапці: $TMPDIR/openclaw-diffs.
• Метадані артефакту переглядача містять:
  • випадковий ID артефакту (20 шістнадцяткових символів)
  • випадковий токен (48 шістнадцяткових символів)
  • createdAt і expiresAt
  • збережений шлях viewer.html
• Типовий TTL артефакту становить 30 хвилин, якщо його не вказано.
• Максимально прийнятий TTL переглядача становить 6 годин.
• Очищення запускається за можливості після створення артефакту.
• Прострочені артефакти видаляються.
• Резервне очищення видаляє застарілі папки старші за 24 години, коли метадані відсутні.

URL переглядача та мережева поведінка

Маршрут переглядача:

• /plugins/diffs/view/{artifactId}/{token}

Ресурси переглядача:

• /plugins/diffs/assets/viewer.js
• /plugins/diffs/assets/viewer-runtime.js
• /plugins/diffs-language-pack/assets/viewer.js, коли diff використовує мову з Diff Viewer Language Pack

Документ переглядача розв’язує ці ресурси відносно URL переглядача, тому необов’язковий префікс шляху baseUrl також зберігається для обох запитів ресурсів.

Поведінка побудови URL:

• Якщо надано baseUrl виклику інструмента, він використовується після суворої перевірки.
• Інакше, якщо налаштовано viewerBaseUrl Plugin, він використовується.
• Без жодного перевизначення URL переглядача типово вказує на loopback 127.0.0.1.
• Якщо режим прив’язування Gateway дорівнює custom і встановлено gateway.customBindHost, використовується цей хост.

Правила baseUrl:

• Має бути http:// або https://.
• Query і hash відхиляються.
• Дозволено origin плюс необов’язковий базовий шлях.

Модель безпеки

Вимоги браузера для файлового режиму

mode: "file" і mode: "both" потребують Chromium-сумісного браузера.

Порядок розв’язання:

Поширений текст помилки:

• Diff PNG/PDF rendering requires a Chromium-compatible browser...

Виправте, встановивши Chrome, Chromium, Edge або Brave, або задавши один із варіантів шляху до виконуваного файла вище.

Усунення несправностей

Операційні рекомендації

• Віддавайте перевагу mode: "view" для локальних інтерактивних оглядів у canvas.
• Віддавайте перевагу mode: "file" для вихідних чат-каналів, яким потрібне вкладення.
• Тримайте allowRemoteViewer вимкненим, якщо ваш deployment не потребує віддалених URL переглядача.
• Задавайте явний короткий ttlSeconds для чутливих diff.
• Уникайте надсилання секретів у ввід diff, коли це не потрібно.
• Якщо ваш канал агресивно стискає зображення (наприклад Telegram або WhatsApp), віддавайте перевагу PDF-виводу (fileFormat: "pdf").

Пов’язане

• Браузер
• Plugins
• Огляд інструментів