Documentation Index
Fetch the complete documentation index at: https://docs2.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 có hướng dẫn hệ thống tích hợp ngắn gọn và một Skills đi kèm, chuyển nội dung thay đổi thành một tạo tác diff chỉ đọc cho tác nhân.
Công cụ chấp nhận một trong hai dạng:
- văn bản
beforevàafter - một
patchhợp nhất
- URL trình xem Gateway để trình bày trên canvas
- đường dẫn tệp đã render (PNG hoặc PDF) để gửi qua tin nhắn
- cả hai đầu ra trong một lần gọi
Bắt đầu nhanh
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:
before_prompt_build của Plugin diffs trong khi vẫn giữ Plugin, công cụ và Skills đi kèm khả dụng.
Nếu bạn muốn tắt cả hướng dẫn và công cụ, hãy tắt Plugin thay vào đó.
Quy trình tác nhân điển hình
Ví dụ đầu vào
- Trước và sau
- Patch
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 nêu rõ.Văn bản gốc. Bắt buộc cùng với
after khi bỏ qua patch.Văn bản đã cập nhật. Bắt buộc cùng với
before khi bỏ qua patch.Văn bản unified diff. Loại trừ lẫn nhau với
before và after.Tên tệp hiển thị cho chế độ trước và sau.
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.
Ghi đè tiêu đề trình xem.
Chế độ đầu ra. Mặc định là mặc định của Plugin
defaults.mode. Bí danh đã lỗi thời: "image" hoạt động như "file" và vẫn được chấp nhận để tương thích ngược.Chủ đề trình xem. Mặc định là mặc định của Plugin
defaults.theme.Bố cục diff. Mặc định là mặc định của Plugin
defaults.layout.Mở rộng các phần không thay đổi khi có ngữ cảnh đầy đủ. Chỉ là tùy chọn cho từng lần gọi (không phải khóa mặc định của Plugin).
Định dạng tệp đã render. Mặc định là mặc định của Plugin
defaults.fileFormat.Preset chất lượng cho render PNG hoặc PDF.
Ghi đè tỷ lệ thiết bị (
1-4).Chiều rộng render tối đa theo pixel CSS (
640-2400).TTL của tạo tác tính bằng giây cho đầu ra trình xem và tệp độc lập. Tối đa 21600.
Ghi đè origin URL trình xem. Ghi đè
viewerBaseUrl của Plugin. Phải là http hoặc https, không có query/hash.Bí danh đầu vào cũ
Bí danh đầu vào cũ
Vẫn được chấp nhận để tương thích ngược:
format->fileFormatimageFormat->fileFormatimageQuality->fileQualityimageScale->fileScaleimageMaxWidth->fileMaxWidth
Xác thực và giới hạn
Xác thực và giới hạn
beforevàaftermỗi trường tối đa 512 KiB.patchtối đa 2 MiB.pathtối đa 2048 byte.langtối đa 128 byte.titletối đa 1024 byte.- Giới hạn độ phức tạp của patch: tối đa 128 tệp và tổng cộng 120000 dòng.
patchcùng vớibeforehoặcaftersẽ bị từ chối.- Giới hạn an toàn cho tệp đã render (áp dụng cho PNG và PDF):
fileQuality: "standard": tối đa 8 MP (8.000.000 pixel đã render).fileQuality: "hq": tối đa 14 MP (14.000.000 pixel đã render).fileQuality: "print": tối đa 24 MP (24.000.000 pixel đã render).- PDF cũng có 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 trongdetails.
Trường trình xem
Trường trình xem
Các trường dùng chung cho những chế độ tạo trình xem:
artifactIdviewerUrlviewerPathtitleexpiresAtinputKindfileCountmodecontext(agentId,sessionId,messageChannel,agentAccountIdkhi có)
Trường tệp
Trường tệp
Các trường tệp khi PNG hoặc PDF được render:
artifactIdexpiresAtfilePathpath(cùng giá trị vớifilePath, để tương thích với công cụ tin nhắn)fileBytesfileFormatfileQualityfileScalefileMaxWidth
Bí danh tương thích
Bí danh tương thích
Cũng được trả về cho các bên gọi hiện có:
format(cùng giá trị vớifileFormat)imagePath(cùng giá trị vớifilePath)imageBytes(cùng giá trị vớifileBytes)imageQuality(cùng giá trị vớifileQuality)imageScale(cùng giá trị vớifileScale)imageMaxWidth(cùng giá trị vớifileMaxWidth)
| Chế độ | Nội dung được trả về |
|---|---|
"view" | Chỉ các trường 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 trình xem cộng với các trường tệp. Nếu render tệp thất bại, trình xem vẫn được trả về với fileError và bí danh imageError. |
Các phần không thay đổ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 đã render 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 unified patch, phần thân ngữ cảnh bị bỏ qua không có sẵn trong các hunk patch đã phân tích, vì vậy 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.
expandUnchangedchỉ áp dụng khi tồn tại 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:
fontFamilyfontSizelineSpacinglayoutshowLineNumbersdiffIndicatorswordWrapbackgroundthemefileFormatfileQualityfileScalefileMaxWidthmodettlSeconds
Cấu hình URL trình xem bền vững
Phương án dự phòng do Plugin sở hữu cho các liên kết trình xem được trả về khi một lần gọi công cụ không truyền
baseUrl. Phải là http hoặc https, không có query/hash.Cấu hình bảo mật
false: các yêu cầu không phải loopback tới tuyến trình xem sẽ bị từ chối. true: trình xem từ xa được cho phép nếu đường dẫn có token hợp lệ.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:
$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)
createdAtvàexpiresAt- đường dẫn
viewer.htmlđã lưu
- TTL tạo tác mặc định 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 sẽ xóa các thư mục cũ hơn 24 giờ khi thiếu siêu dữ liệu.
Hành vi URL trình xem và mạng
Tuyến trình xem:/plugins/diffs/view/{artifactId}/{token}
/plugins/diffs/assets/viewer.js/plugins/diffs/assets/viewer-runtime.js
baseUrl tùy chọn cũng được giữ cho cả các yêu cầu tài nguyên.
Hành vi xây dựng URL:
- Nếu
baseUrlcủa lần gọi công cụ được cung cấp, nó sẽ được sử dụng sau khi xác thực nghiêm ngặt. - Nếu không, nếu
viewerBaseUrlcủa Plugin được cấu hình, nó sẽ được sử dụng. - Nếu không có ghi đè nào, URL trình xem mặc định là loopback
127.0.0.1. - Nếu chế độ bind Gateway là
customvàgateway.customBindHostđược đặt, host đó sẽ được sử dụng.
baseUrl:
- Phải là
http://hoặchttps://. - Query và hash sẽ bị từ chối.
- Origin cộng với đường dẫn cơ sở tùy chọn được cho phép.
Mô hình bảo mật
Gia cố trình xem
Gia cố trình xem
- Theo mặc định chỉ cho phép loopback.
- Đường dẫn trình xem được mã hóa token với kiểm 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ừ chính nguồn
- không có
connect-srcđi ra ngoài
- Điều tiết lỗi truy cập từ xa khi quyền truy cập từ xa được bật:
- 40 lỗi mỗi 60 giây
- khóa 60 giây (
429 Too Many Requests)
Gia cố kết xuất tệp
Gia cố kết xuất tệp
- Định tuyến yêu cầu trình duyệt chụp 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/*. - 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" và mode: "both" cần trình duyệt tương thích với Chromium.
Thứ tự phân giải:
Biến môi trường
OPENCLAW_BROWSER_EXECUTABLE_PATHBROWSER_EXECUTABLE_PATHPLAYWRIGHT_CHROMIUM_EXECUTABLE_PATH
Diff PNG/PDF rendering requires a Chromium-compatible browser...
Khắc phục sự cố
Lỗi kiểm thực đầu vào
Lỗi kiểm thực đầu vào
Provide patch or both before and after text.— bao gồm cảbeforevàafter, hoặc cung cấppatch.Provide either patch or before/after input, not both.— không trộn các chế độ đầu vào.Invalid baseUrl: ...— dùng originhttp(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 bản vá lớn — giảm số lượng tệp bản vá hoặc tổng số dòng.
Khả năng truy cập trình xem
Khả năng truy cập trình xem
- Theo mặc định, URL trình xem phân giải thành
127.0.0.1. - Đối với các kịch bản truy cập từ xa, hãy:
- đặt
viewerBaseUrlcủa plugin, hoặc - truyền
baseUrlcho từng lần gọi công cụ, hoặc - dùng
gateway.bind=customvàgateway.customBindHost
- đặt
- Nếu
gateway.trustedProxiesbao 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 IP máy khách được chuyển tiếp sẽ bị đóng theo thiết kế. - Với cấu trúc proxy đó:
- ưu tiên
mode: "file"hoặcmode: "both"khi bạn chỉ cần tệp đính kèm, hoặc - chủ ý bật
security.allowRemoteViewervà đặtviewerBaseUrlcủa plugin hoặc truyềnbaseUrlproxy/công khai khi bạn cần URL trình xem có thể chia sẻ
- ưu tiên
- Chỉ bật
security.allowRemoteViewerkhi bạn có ý định cho phép truy cập trình xem từ bên ngoài.
Hàng dòng chưa sửa đổi không có nút mở rộng
Hàng dòng chưa sửa đổi không có nút mở rộng
Điều này có thể xảy ra với đầu vào bản vá khi bản vá 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.
Không tìm thấy artifact
Không tìm thấy artifact
- Artifact đã hết hạn do TTL.
- Token hoặc đường dẫn đã thay đổi.
- Tác vụ 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 chat đi ra ngoài cần tệp đính kèm. - Giữ
allowRemoteViewerở trạng thái tắt trừ khi triển khai của bạn yêu cầu URL trình xem từ xa. - Đặt
ttlSecondsngắn và 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 ả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 vận hành bởi Diffs.