Chuyển đến nội dung chính

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 là một công cụ plugin tùy chọn với hướng dẫn hệ thống tích hợp ngắn gọn và một skill đi kèm, giúp chuyển nội dung thay đổi thành một hiện vật diff chỉ đọc cho agent. Công cụ này chấp nhận một trong hai:
  • văn bản beforeafter
  • một patch hợp nhất
Công cụ có thể trả về:
  • URL trình xem gateway để trình bày trên canvas
  • đường dẫn tệp đã kết xuất (PNG hoặc PDF) để gửi qua tin nhắn
  • cả hai đầu ra trong một lần gọi
Khi được bật, plugin sẽ thêm trước hướng dẫn sử dụng ngắn gọn vào không gian system-prompt và cũng cung cấp một skill chi tiết cho các trường hợp agent cần hướng dẫn đầy đủ hơn.

Bắt đầu nhanh

1

Bật plugin

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

Chọn một chế độ

Luồng ưu tiên canvas: agent gọi diffs với mode: "view" và mở details.viewerUrl bằng canvas present.

Tắt hướng dẫn hệ thống tích hợp

Nếu bạn muốn giữ công cụ diffs được bật nhưng tắt hướng dẫn system-prompt tích hợp của nó, hãy đặt plugins.entries.diffs.hooks.allowPromptInjection thành false:
{
  plugins: {
    entries: {
      diffs: {
        enabled: true,
        hooks: {
          allowPromptInjection: false,
        },
      },
    },
  },
}
Điều này chặn hook before_prompt_build của plugin diffs trong khi vẫn giữ plugin, công cụ và skill đi kèm khả dụng. Nếu bạn muốn tắt cả hướng dẫn lẫn công cụ, hãy tắt plugin.

Quy trình agent điển hình

1

Gọi diffs

Agent gọi công cụ diffs với đầu vào.
2

Đọc chi tiết

Agent đọc các trường details từ phản hồi.
3

Trình bày

Agent mở details.viewerUrl bằng canvas present, gửi details.filePath bằng message sử dụng path hoặc filePath, hoặc thực hiện cả hai.

Ví dụ đầu vào

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

Tham chiếu đầu vào công cụ

Tất cả các trường đều là tùy chọn trừ khi có ghi chú khác.
before
string
Văn bản gốc. Bắt buộc cùng với after khi bỏ qua patch.
after
string
Văn bản đã cập nhật. Bắt buộc cùng với before khi bỏ qua patch.
patch
string
Văn bản diff hợp nhất. Loại trừ lẫn nhau với beforeafter.
path
string
Tên tệp hiển thị cho chế độ trước và sau.
lang
string
Gợi ý ghi đè ngôn ngữ cho chế độ trước và sau. Giá trị không xác định sẽ quay về văn bản thuần.
title
string
Ghi đè tiêu đề trình xem.
mode
"view" | "file" | "both"
Chế độ đầu ra. Mặc định là giá trị mặc định của plugin defaults.mode. Bí danh đã ngừng khuyến nghị: "image" hoạt động như "file" và vẫn được chấp nhận để tương thích ngược.
theme
"light" | "dark"
Chủ đề trình xem. Mặc định là giá trị mặc định của plugin defaults.theme.
layout
"unified" | "split"
Bố cục diff. Mặc định là giá trị mặc định của plugin defaults.layout.
expandUnchanged
boolean
Mở rộng các phần không thay đổi khi có đủ ngữ cảnh. Chỉ là tùy chọn theo từng lần gọi (không phải khóa mặc định của plugin).
fileFormat
"png" | "pdf"
Định dạng tệp đã kết xuất. Mặc định là giá trị mặc định của plugin defaults.fileFormat.
fileQuality
"standard" | "hq" | "print"
Cài đặt sẵn chất lượng cho kết xuất PNG hoặc PDF.
fileScale
number
Ghi đè tỷ lệ thiết bị (1-4).
fileMaxWidth
number
Chiều rộng kết xuất tối đa tính bằng pixel CSS (640-2400).
ttlSeconds
number
mặc định:"1800"
TTL của hiện vật tính bằng giây cho đầu ra trình xem và tệp độc lập. Tối đa 21600.
baseUrl
string
Ghi đè origin URL trình xem. Ghi đè viewerBaseUrl của plugin. Phải là http hoặc https, không có query/hash.
Vẫn được chấp nhận để tương thích ngược:
  • format -> fileFormat
  • imageFormat -> fileFormat
  • imageQuality -> fileQuality
  • imageScale -> fileScale
  • imageMaxWidth -> fileMaxWidth
  • beforeafter mỗi trường tối đa 512 KiB.
  • patch tối đa 2 MiB.
  • path tối đa 2048 byte.
  • lang tối đa 128 byte.
  • title tối đa 1024 byte.
  • Giới hạn độ phức tạp patch: tối đa 128 tệp và tổng cộng 120000 dòng.
  • patch đi cùng before hoặc after sẽ bị từ chối.
  • Giới hạn an toàn cho tệp đã kết xuất (áp dụng cho PNG và PDF):
    • fileQuality: "standard": tối đa 8 MP (8.000.000 pixel đã kết xuất).
    • fileQuality: "hq": tối đa 14 MP (14.000.000 pixel đã kết xuất).
    • fileQuality: "print": tối đa 24 MP (24.000.000 pixel đã kết xuất).
    • PDF cũng có giới hạn tối đa 50 trang.

Hợp đồng chi tiết đầu ra

Công cụ trả về siêu dữ liệu có cấu trúc trong details.
Các trường dùng chung cho những chế độ tạo trình xem:
  • artifactId
  • viewerUrl
  • viewerPath
  • title
  • expiresAt
  • inputKind
  • fileCount
  • mode
  • context (agentId, sessionId, messageChannel, agentAccountId khi có)
Các trường tệp khi PNG hoặc PDF được kết xuất:
  • artifactId
  • expiresAt
  • filePath
  • path (cùng giá trị với filePath, để tương thích với công cụ nhắn tin)
  • fileBytes
  • fileFormat
  • fileQuality
  • fileScale
  • fileMaxWidth
Cũng được trả về cho các caller hiện có:
  • format (cùng giá trị với fileFormat)
  • imagePath (cùng giá trị với filePath)
  • imageBytes (cùng giá trị với fileBytes)
  • imageQuality (cùng giá trị với fileQuality)
  • imageScale (cùng giá trị với fileScale)
  • imageMaxWidth (cùng giá trị với fileMaxWidth)
Tóm tắt hành vi chế độ:
Chế độNội dung được trả về
"view"Chỉ các trường của trình xem.
"file"Chỉ các trường tệp, không có tạo tác trình xem.
"both"Các trường của trình xem cùng với các trường tệp. Nếu kết xuất tệp thất bại, trình xem vẫn trả về với bí danh fileErrorimageError.

Các phần không đổi được thu gọn

  • Trình xem có thể hiển thị các hàng như N unmodified lines.
  • Các điều khiển mở rộng trên những hàng đó là có điều kiện và không được bảo đảm cho mọi loại đầu vào.
  • Các điều khiển mở rộng xuất hiện khi diff đã kết xuất có dữ liệu ngữ cảnh có thể mở rộng, điều này thường gặp với đầu vào trước và sau.
  • Với nhiều đầu vào bản vá hợp nhất, phần thân ngữ cảnh bị lược bỏ không có sẵn trong các hunk bản vá đã phân tích, nên hàng có thể xuất hiện mà không có điều khiển mở rộng. Đây là hành vi dự kiến.
  • expandUnchanged chỉ áp dụng khi có ngữ cảnh có thể mở rộng.

Mặc định của Plugin

Đặt mặc định trên toàn Plugin trong ~/.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",
          },
        },
      },
    },
  },
}
Các mặc định được hỗ trợ:
  • fontFamily
  • fontSize
  • lineSpacing
  • layout
  • showLineNumbers
  • diffIndicators
  • wordWrap
  • background
  • theme
  • fileFormat
  • fileQuality
  • fileScale
  • fileMaxWidth
  • mode
Các tham số công cụ tường minh sẽ ghi đè những mặc định này.

Cấu hình URL trình xem bền vững

viewerBaseUrl
string
Dự phòng do Plugin sở hữu cho các liên kết trình xem được trả về khi lệnh gọi công cụ không truyền baseUrl. Phải là http hoặc https, không có query/hash.
{
  plugins: {
    entries: {
      diffs: {
        enabled: true,
        config: {
          viewerBaseUrl: "https://gateway.example.com/openclaw",
        },
      },
    },
  },
}

Cấu hình bảo mật

security.allowRemoteViewer
boolean
mặc định:"false"
false: các yêu cầu không phải loopback đến tuyến trình xem bị từ chối. true: trình xem từ xa được cho phép nếu đường dẫn có token hợp lệ.
{
  plugins: {
    entries: {
      diffs: {
        enabled: true,
        config: {
          security: {
            allowRemoteViewer: false,
          },
        },
      },
    },
  },
}

Vòng đời và lưu trữ tạo tác

  • Tạo tác được lưu trong thư mục con tạm thời: $TMPDIR/openclaw-diffs.
  • Siêu dữ liệu tạo tác trình xem chứa:
    • ID tạo tác ngẫu nhiên (20 ký tự hex)
    • token ngẫu nhiên (48 ký tự hex)
    • createdAtexpiresAt
    • đường dẫn viewer.html đã lưu
  • TTL mặc định của tạo tác là 30 phút khi không được chỉ định.
  • TTL trình xem tối đa được chấp nhận là 6 giờ.
  • Dọn dẹp chạy theo cơ hội sau khi tạo tạo tác.
  • Tạo tác đã hết hạn sẽ bị xóa.
  • Dọn dẹp dự phòng xóa các thư mục cũ hơn 24 giờ khi thiếu siêu dữ liệu.

URL trình xem và hành vi mạng

Tuyến trình xem:
  • /plugins/diffs/view/{artifactId}/{token}
Tài nguyên trình xem:
  • /plugins/diffs/assets/viewer.js
  • /plugins/diffs/assets/viewer-runtime.js
Tài liệu trình xem phân giải các tài nguyên đó tương đối với URL trình xem, nên tiền tố đường dẫn baseUrl tùy chọn cũng được giữ nguyên cho cả các yêu cầu tài nguyên. Hành vi xây dựng URL:
  • Nếu baseUrl của lệnh gọi công cụ được cung cấp, nó sẽ được dùng sau khi xác thực nghiêm ngặt.
  • Nếu không, nếu viewerBaseUrl của Plugin được cấu hình, nó sẽ được dùng.
  • Khi không có ghi đè nào, URL trình xem mặc định là loopback 127.0.0.1.
  • Nếu chế độ bind của Gateway là customgateway.customBindHost được đặt, host đó sẽ được dùng.
Quy tắc baseUrl:
  • Phải là http:// hoặc https://.
  • Query và hash bị từ chối.
  • Cho phép origin cộng với đường dẫn cơ sở tùy chọn.

Mô hình bảo mật

  • Mặc định chỉ cho phép loopback.
  • Đường dẫn trình xem có token với xác thực ID và token nghiêm ngặt.
  • CSP phản hồi của trình xem:
    • default-src 'none'
    • script và tài nguyên chỉ từ self
    • không có connect-src đi ra ngoài
  • Giới hạn tốc độ các lần truy cập từ xa bị trượt khi quyền truy cập từ xa được bật:
    • 40 lần thất bại mỗi 60 giây
    • khóa 60 giây (429 Too Many Requests)
  • Định tuyến yêu cầu trình duyệt chụp ảnh màn hình mặc định là từ chối.
  • Chỉ cho phép tài nguyên trình xem cục bộ từ http://127.0.0.1/plugins/diffs/assets/*.
  • Các yêu cầu mạng bên ngoài bị chặn.

Yêu cầu trình duyệt cho chế độ tệp

mode: "file"mode: "both" cần trình duyệt tương thích với Chromium. Thứ tự phân giải:
1

Cấu hình

browser.executablePath trong cấu hình OpenClaw.
2

Biến môi trường

  • OPENCLAW_BROWSER_EXECUTABLE_PATH
  • BROWSER_EXECUTABLE_PATH
  • PLAYWRIGHT_CHROMIUM_EXECUTABLE_PATH
3

Dự phòng nền tảng

Phương án dự phòng khám phá lệnh/đường dẫn của nền tảng.
Văn bản lỗi thường gặp:
  • Diff PNG/PDF rendering requires a Chromium-compatible browser...
Khắc phục bằng cách cài đặt Chrome, Chromium, Edge hoặc Brave, hoặc đặt một trong các tùy chọn đường dẫn tệp thực thi ở trên.

Khắc phục sự cố

  • Provide patch or both before and after text. — bao gồm cả beforeafter, hoặc cung cấp patch.
  • Provide either patch or before/after input, not both. — không trộn các chế độ đầu vào.
  • Invalid baseUrl: ... — dùng origin http(s) với đường dẫn tùy chọn, không có query/hash.
  • {field} exceeds maximum size (...) — giảm kích thước payload.
  • Từ chối patch lớn — giảm số lượng tệp patch hoặc tổng số dòng.
  • URL trình xem mặc định phân giải tới 127.0.0.1.
  • Đối với các kịch bản truy cập từ xa, hãy:
    • đặt viewerBaseUrl của Plugin, hoặc
    • truyền baseUrl cho từng lệnh gọi công cụ, hoặc
    • dùng gateway.bind=customgateway.customBindHost
  • Nếu gateway.trustedProxies bao gồm loopback cho proxy cùng máy chủ (ví dụ Tailscale Serve), các yêu cầu trình xem loopback thô không có header client-IP được chuyển tiếp sẽ đóng thất bại theo thiết kế.
  • Với topo proxy đó:
    • ưu tiên mode: "file" hoặc mode: "both" khi bạn chỉ cần tệp đính kèm, hoặc
    • chủ ý bật security.allowRemoteViewer và đặt viewerBaseUrl của Plugin hoặc truyền baseUrl proxy/công khai khi bạn cần URL trình xem có thể chia sẻ
  • Chỉ bật security.allowRemoteViewer khi bạn dự định cho phép truy cập trình xem từ bên ngoài.
Điều này có thể xảy ra với đầu vào patch khi patch không mang theo ngữ cảnh có thể mở rộng. Đây là hành vi dự kiến và không cho thấy trình xem bị lỗi.
  • Artifact hết hạn do TTL.
  • Token hoặc đường dẫn đã thay đổi.
  • Dọn dẹp đã xóa dữ liệu cũ.

Hướng dẫn vận hành

  • Ưu tiên mode: "view" cho các phiên đánh giá tương tác cục bộ trong canvas.
  • Ưu tiên mode: "file" cho các kênh trò chuyện gửi đi cần tệp đính kèm.
  • Giữ allowRemoteViewer tắt trừ khi triển khai của bạn yêu cầu URL trình xem từ xa.
  • Đặt ttlSeconds ngắn rõ ràng cho các diff nhạy cảm.
  • Tránh gửi bí mật trong đầu vào diff khi không bắt buộc.
  • Nếu kênh của bạn nén hình ảnh mạnh (ví dụ Telegram hoặc WhatsApp), hãy ưu tiên đầu ra PDF (fileFormat: "pdf").
Công cụ kết xuất diff được hỗ trợ bởi Diffs.

Liên quan