Tools
Różnice
diffs to opcjonalne narzędzie Plugin z krótkimi wbudowanymi wskazówkami systemowymi i towarzyszącą mu umiejętnością, która przekształca treść zmian w artefakt różnic tylko do odczytu dla agentów.
Przyjmuje jedno z poniższych:
- tekst
beforeiafter - ujednolicony
patch
Może zwrócić:
- adres URL przeglądarki Gateway do prezentacji na kanwie
- ścieżkę wyrenderowanego pliku (PNG lub PDF) do dostarczenia w wiadomości
- oba wyniki w jednym wywołaniu
Po włączeniu Plugin dodaje zwięzłe wskazówki użycia do przestrzeni promptu systemowego i udostępnia też szczegółową umiejętność dla przypadków, w których agent potrzebuje pełniejszych instrukcji.
Szybki start
Install the plugin
openclaw plugins install diffs
Enable the plugin
{
plugins: {
entries: {
diffs: {
enabled: true,
},
},
},
}
Pick a mode
view
Przepływy z kanwą jako pierwszym widokiem: agenci wywołują diffs z mode: "view" i otwierają details.viewerUrl za pomocą canvas present.
file
Dostarczanie pliku na czacie: agenci wywołują diffs z mode: "file" i wysyłają details.filePath za pomocą message, używając path lub filePath.
both
Tryb łączony: agenci wywołują diffs z mode: "both", aby uzyskać oba artefakty w jednym wywołaniu.
Wyłączanie wbudowanych wskazówek systemowych
Jeśli chcesz pozostawić narzędzie diffs włączone, ale wyłączyć jego wbudowane wskazówki promptu systemowego, ustaw plugins.entries.diffs.hooks.allowPromptInjection na false:
{
plugins: {
entries: {
diffs: {
enabled: true,
hooks: {
allowPromptInjection: false,
},
},
},
},
}
Blokuje to hook before_prompt_build Plugin diffs, pozostawiając Plugin, narzędzie i towarzyszącą umiejętność dostępne.
Jeśli chcesz wyłączyć zarówno wskazówki, jak i narzędzie, wyłącz zamiast tego Plugin.
Typowy przepływ pracy agenta
Call diffs
Agent wywołuje narzędzie diffs z danymi wejściowymi.
Read details
Agent odczytuje pola details z odpowiedzi.
Present
Agent otwiera details.viewerUrl za pomocą canvas present, wysyła details.filePath za pomocą message, używając path lub filePath, albo robi jedno i drugie.
Przykłady danych wejściowych
Before and after
{
"before": "# Hello\n\nOne",
"after": "# Hello\n\nTwo",
"path": "docs/example.md",
"mode": "view"
}
Patch
{
"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"
}
Dokumentacja danych wejściowych narzędzia
Wszystkie pola są opcjonalne, chyba że zaznaczono inaczej.
beforestringOryginalny tekst. Wymagane z after, gdy pominięto patch.
afterstringZaktualizowany tekst. Wymagane z before, gdy pominięto patch.
patchstringTekst ujednoliconego diffu. Wzajemnie wyklucza się z before i after.
pathstringWyświetlana nazwa pliku dla trybu przed i po.
langstringWskazówka nadpisania języka dla trybu przed i po. Nieznane wartości wracają do zwykłego tekstu.
titlestringNadpisanie tytułu przeglądarki.
mode"view" | "file" | "both"Tryb wyjścia. Domyślnie używa wartości domyślnej Plugin defaults.mode. Przestarzały alias: "image" działa jak "file" i nadal jest akceptowany ze względu na zgodność wsteczną.
theme"light" | "dark"Motyw przeglądarki. Domyślnie używa wartości domyślnej Plugin defaults.theme.
layout"unified" | "split"Układ diffu. Domyślnie używa wartości domyślnej Plugin defaults.layout.
expandUnchangedbooleanRozwijaj niezmienione sekcje, gdy dostępny jest pełny kontekst. Tylko opcja pojedynczego wywołania (nie jest domyślnym kluczem Plugin).
fileFormat"png" | "pdf"Format wyrenderowanego pliku. Domyślnie używa wartości domyślnej Plugin defaults.fileFormat.
fileQuality"standard" | "hq" | "print"Ustawienie jakości renderowania PNG lub PDF.
fileScalenumberNadpisanie skali urządzenia (1-4).
fileMaxWidthnumberMaksymalna szerokość renderowania w pikselach CSS (640-2400).
ttlSecondsnumberTTL artefaktu w sekundach dla wyjść przeglądarki i samodzielnego pliku. Maksymalnie 21600.
baseUrlstringNadpisanie źródła adresu URL przeglądarki. Nadpisuje viewerBaseUrl Plugin. Musi być http lub https, bez zapytania ani hasha.
Legacy input aliases
Nadal akceptowane ze względu na zgodność wsteczną:
format->fileFormatimageFormat->fileFormatimageQuality->fileQualityimageScale->fileScaleimageMaxWidth->fileMaxWidth
Validation and limits
beforeiafter: każde maks. 512 KiB.patch: maks. 2 MiB.path: maks. 2048 bajtów.lang: maks. 128 bajtów.title: maks. 1024 bajty.- Limit złożoności łatki: maks. 128 plików i 120000 łącznych wierszy.
- Jednoczesne użycie
patchorazbeforelubafterjest odrzucane. - Limity bezpieczeństwa wyrenderowanego pliku (dotyczą PNG i PDF):
fileQuality: "standard": maks. 8 MP (8 000 000 wyrenderowanych pikseli).fileQuality: "hq": maks. 14 MP (14 000 000 wyrenderowanych pikseli).fileQuality: "print": maks. 24 MP (24 000 000 wyrenderowanych pikseli).- PDF ma również limit 50 stron.
Kontrakt szczegółów wyjścia
Narzędzie zwraca ustrukturyzowane metadane w details.
Viewer fields
Wspólne pola dla trybów, które tworzą przeglądarkę:
artifactIdviewerUrlviewerPathtitleexpiresAtinputKindfileCountmodecontext(agentId,sessionId,messageChannel,agentAccountId, gdy dostępne)
File fields
Pola pliku, gdy renderowany jest PNG lub PDF:
artifactIdexpiresAtfilePathpath(ta sama wartość cofilePath, dla zgodności z narzędziem wiadomości)fileBytesfileFormatfileQualityfileScalefileMaxWidth
Compatibility aliases
Zwracane również dla istniejących wywołujących:
format(ta sama wartość cofileFormat)imagePath(ta sama wartość cofilePath)imageBytes(ta sama wartość cofileBytes)imageQuality(ta sama wartość cofileQuality)imageScale(ta sama wartość cofileScale)imageMaxWidth(ta sama wartość cofileMaxWidth)
Podsumowanie zachowania trybów:
| Tryb | Co jest zwracane |
|---|---|
"view" |
Tylko pola przeglądarki. |
"file" |
Tylko pola pliku, bez artefaktu przeglądarki. |
"both" |
Pola przeglądarki oraz pola pliku. Jeśli renderowanie pliku się nie powiedzie, przeglądarka nadal zwraca alias fileError i imageError. |
Zwinięte niezmienione sekcje
- Przeglądarka może pokazywać wiersze takie jak
N unmodified lines. - Elementy sterujące rozwijaniem w tych wierszach są warunkowe i nie są gwarantowane dla każdego rodzaju danych wejściowych.
- Elementy sterujące rozwijaniem pojawiają się, gdy wyrenderowany diff zawiera rozwijalne dane kontekstowe, co jest typowe dla danych wejściowych przed i po.
- W przypadku wielu danych wejściowych w postaci ujednoliconych łatek pominięte treści kontekstu nie są dostępne w sparsowanych hunkach łatki, więc wiersz może pojawić się bez elementów sterujących rozwijaniem. To oczekiwane zachowanie.
expandUnchangedma zastosowanie tylko wtedy, gdy istnieje rozwijalny kontekst.
Wartości domyślne Plugin
Ustaw wartości domyślne dla całego Plugin w ~/.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",
},
},
},
},
},
}
Obsługiwane wartości domyślne:
fontFamilyfontSizelineSpacinglayoutshowLineNumbersdiffIndicatorswordWrapbackgroundthemefileFormatfileQualityfileScalefileMaxWidthmode
Jawne parametry narzędzia nadpisują te wartości domyślne.
Konfiguracja trwałego adresu URL przeglądarki
viewerBaseUrlstringFallback należący do Plugin dla zwracanych linków przeglądarki, gdy wywołanie narzędzia nie przekazuje baseUrl. Musi być http lub https, bez zapytania ani hasha.
{
plugins: {
entries: {
diffs: {
enabled: true,
config: {
viewerBaseUrl: "https://gateway.example.com/openclaw",
},
},
},
},
}
Konfiguracja bezpieczeństwa
security.allowRemoteViewerbooleanfalse: żądania do tras przeglądarki spoza loopback są odrzucane. true: zdalne przeglądarki są dozwolone, jeśli ścieżka z tokenem jest prawidłowa.
{
plugins: {
entries: {
diffs: {
enabled: true,
config: {
security: {
allowRemoteViewer: false,
},
},
},
},
},
}
Cykl życia artefaktu i przechowywanie
- Artefakty są przechowywane w tymczasowym podfolderze:
$TMPDIR/openclaw-diffs. - Metadane artefaktu przeglądarki zawierają:
- losowy identyfikator artefaktu (20 znaków szesnastkowych)
- losowy token (48 znaków szesnastkowych)
createdAtiexpiresAt- zapisaną ścieżkę
viewer.html
- Domyślny TTL artefaktu wynosi 30 minut, gdy nie zostanie określony.
- Maksymalny akceptowany TTL przeglądarki wynosi 6 godzin.
- Czyszczenie uruchamia się oportunistycznie po utworzeniu artefaktu.
- Wygasłe artefakty są usuwane.
- Czyszczenie fallback usuwa nieaktualne foldery starsze niż 24 godziny, gdy brakuje metadanych.
Adres URL przeglądarki i zachowanie sieci
Trasa przeglądarki:
/plugins/diffs/view/{artifactId}/{token}
Zasoby przeglądarki:
/plugins/diffs/assets/viewer.js/plugins/diffs/assets/viewer-runtime.js
Dokument przeglądarki rozwiązuje te zasoby względem adresu URL przeglądarki, więc opcjonalny prefiks ścieżki baseUrl jest zachowywany także dla obu żądań zasobów.
Zachowanie konstruowania adresu URL:
- Jeśli podano
baseUrlw wywołaniu narzędzia, jest ono używane po ścisłej walidacji. - W przeciwnym razie, jeśli skonfigurowano
viewerBaseUrlPlugin, jest ono używane. - Bez żadnego z tych nadpisań adres URL przeglądarki domyślnie wskazuje loopback
127.0.0.1. - Jeśli tryb bindowania Gateway to
customi ustawionogateway.customBindHost, używany jest ten host.
Reguły baseUrl:
- Musi być
http://lubhttps://. - Zapytanie i hash są odrzucane.
- Dozwolone jest źródło oraz opcjonalna ścieżka bazowa.
Model bezpieczeństwa
Wzmocnienie zabezpieczeń viewer
- Domyślnie tylko przez local loopback.
- Tokenizowane ścieżki viewer ze ścisłą walidacją identyfikatora i tokenu.
- CSP odpowiedzi viewer:
default-src 'none'- skrypty i zasoby tylko z własnego źródła
- brak wychodzącego
connect-src
- Ograniczanie zdalnych nieudanych prób, gdy dostęp zdalny jest włączony:
- 40 niepowodzeń na 60 sekund
- 60-sekundowa blokada (
429 Too Many Requests)
Wzmocnienie renderowania plików
- Routing żądań przeglądarki do zrzutów ekranu domyślnie odmawia dostępu.
- Dozwolone są tylko lokalne zasoby viewer z
http://127.0.0.1/plugins/diffs/assets/*. - Zewnętrzne żądania sieciowe są blokowane.
Wymagania przeglądarki dla trybu pliku
mode: "file" i mode: "both" wymagają przeglądarki zgodnej z Chromium.
Kolejność rozpoznawania:
Konfiguracja
browser.executablePath w konfiguracji OpenClaw.
Zmienne środowiskowe
OPENCLAW_BROWSER_EXECUTABLE_PATHBROWSER_EXECUTABLE_PATHPLAYWRIGHT_CHROMIUM_EXECUTABLE_PATH
Zapasowy mechanizm platformy
Zapasowe wykrywanie polecenia/ścieżki platformy.
Typowy tekst błędu:
Diff PNG/PDF rendering requires a Chromium-compatible browser...
Napraw to, instalując Chrome, Chromium, Edge albo Brave, lub ustawiając jedną z powyższych opcji ścieżki do pliku wykonywalnego.
Rozwiązywanie problemów
Błędy walidacji danych wejściowych
Provide patch or both before and after text.— dołącz oba polabeforeiafteralbo podajpatch.Provide either patch or before/after input, not both.— nie mieszaj trybów wejściowych.Invalid baseUrl: ...— użyj źródłahttp(s)z opcjonalną ścieżką, bez zapytania/hasza.{field} exceeds maximum size (...)— zmniejsz rozmiar payloadu.- Odrzucenie dużej łatki — zmniejsz liczbę plików łatki albo łączną liczbę wierszy.
Dostępność viewer
- URL viewer domyślnie rozpoznaje się na
127.0.0.1. - W scenariuszach dostępu zdalnego:
- ustaw
viewerBaseUrlPlugin, albo - przekaż
baseUrldla każdego wywołania narzędzia, albo - użyj
gateway.bind=customigateway.customBindHost
- ustaw
- Jeśli
gateway.trustedProxiesobejmuje local loopback dla proxy na tym samym hoście (na przykład Tailscale Serve), surowe żądania viewer przez local loopback bez przekazanych nagłówków client-IP zawodzą w trybie zamkniętym zgodnie z projektem. - Dla tej topologii proxy:
- preferuj
mode: "file"albomode: "both", gdy potrzebujesz tylko załącznika, albo - celowo włącz
security.allowRemoteVieweri ustawviewerBaseUrlPlugin lub przekaż proxy/publicznybaseUrl, gdy potrzebujesz udostępnialnego URL viewer
- preferuj
- Włączaj
security.allowRemoteViewertylko wtedy, gdy zamierzasz udostępnić zewnętrzny dostęp do viewer.
Wiersz niezmodyfikowanych linii nie ma przycisku rozwijania
Może się tak zdarzyć dla danych wejściowych łatki, gdy łatka nie zawiera rozwijalnego kontekstu. Jest to oczekiwane i nie oznacza awarii viewer.
Nie znaleziono artefaktu
- Artefakt wygasł z powodu TTL.
- Token albo ścieżka się zmieniły.
- Czyszczenie usunęło nieaktualne dane.
Wskazówki operacyjne
- Preferuj
mode: "view"dla lokalnych interaktywnych przeglądów w canvas. - Preferuj
mode: "file"dla wychodzących kanałów czatu, które potrzebują załącznika. - Pozostaw
allowRemoteViewerwyłączone, chyba że wdrożenie wymaga zdalnych adresów URL viewer. - Ustaw jawnie krótkie
ttlSecondsdla wrażliwych diffów. - Unikaj wysyłania sekretów w danych wejściowych diffu, gdy nie jest to wymagane.
- Jeśli Twój kanał agresywnie kompresuje obrazy (na przykład Telegram albo WhatsApp), preferuj wyjście PDF (
fileFormat: "pdf").