Các khác biệt

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 Skills đi kèm, dùng để chuyển nội dung thay đổi thành một tạo tác diff chỉ đọc cho tác nhân.

Nó chấp nhận một trong hai dạng:

• văn bản before và after
• một patch hợp nhất

Nó có thể trả về:

• 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

Khi được bật, Plugin sẽ thêm 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 Skills chi tiết cho các trường hợp tác nhân cần hướng dẫn đầy đủ hơn.

Bắt đầu nhanh

openclaw plugins install diffs

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

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ó, đặ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à Skills đ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 thay vào đó.

Quy trình tác nhân điển hình

Ví dụ đầu vào

{  "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"}

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ú.

Tô sáng cú pháp

OpenClaw bao gồm tô sáng cú pháp cho các ngôn ngữ mã nguồn, cấu hình và tài liệu phổ biến:

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, và toml.

Các bí danh phổ biến như js, ts, bash, md, yml, c++, dockerfile, rb, kt, và ps1 được chuẩn hóa thành các ngôn ngữ mặc định đó.

Cài đặt Plugin Gói ngôn ngữ của Trình xem Diff để tô sáng các ngôn ngữ khác:

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

Khi có gói ngôn ngữ, OpenClaw có thể tô sáng nhiều ngôn ngữ hơn. Nếu gói chưa được cài đặt, các tệp nằm ngoài danh sách mặc định vẫn được hiển thị dưới dạng văn bản thuần dễ đọc. Ví dụ bao gồm 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 và các tệp diff.

Xem Plugin Gói ngôn ngữ Diffs để biết chi tiết và ngôn ngữ Shiki để xem danh mục ngôn ngữ thượng nguồn và bí danh của Shiki.

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.

Tóm tắt hành vi chế độ:

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

• Trình xem có thể hiển thị các hàng như N unmodified lines.
• Điều khiển mở rộng trên các hàng đó là có điều kiện và không được bảo đảm cho mọi loại đầu vào.
• Đ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ị bỏ qua không có sẵn trong các hunk bản vá đã 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.
• expandUnchanged chỉ áp dụng khi ngữ cảnh có thể mở rộng tồn tại.

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",            ttlSeconds: 21600,          },        },      },    },  },}

Các mặc định được hỗ trợ:

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

Các tham số công cụ tường minh sẽ ghi đè các mặc định này.

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

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

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

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

Vòng đời artifact và lưu trữ

• Các artifact được lưu trong thư mục con tạm thời: $TMPDIR/openclaw-diffs.
• Siêu dữ liệu artifact của trình xem chứa:
  • ID artifact ngẫu nhiên (20 ký tự hex)
  • token ngẫu nhiên (48 ký tự hex)
  • createdAt và expiresAt
  • đường dẫn viewer.html đã lưu
• TTL artifact 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 artifact.
• Artifact hết hạn sẽ bị xóa.
• Dọn dẹp dự phòng loại bỏ 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
• /plugins/diffs-language-pack/assets/viewer.js khi diff dùng một ngôn ngữ từ Diff Viewer Language Pack

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 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 Plugin viewerBaseUrl đượ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à custom và gateway.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.
• 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

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 Chromium.

Thứ tự phân giải:

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ố

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

• Ưu tiên mode: "view" cho các phiên review tương tác cục bộ trong canvas.
• Ưu tiên mode: "file" cho các kênh chat gử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 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 cần thiết.
• 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").

Liên quan

• Trình duyệt
• Plugin
• Tổng quan về công cụ