ส่วนต่าง

diffs เป็นเครื่องมือ Plugin แบบไม่บังคับที่มีคำแนะนำระบบในตัวแบบสั้น และมี Skill คู่กันที่แปลงเนื้อหาการเปลี่ยนแปลงเป็นอาร์ติแฟกต์ diff แบบอ่านอย่างเดียวสำหรับเอเจนต์

รองรับอย่างใดอย่างหนึ่งต่อไปนี้:

• ข้อความ before และ after
• patch แบบ unified

สามารถส่งคืน:

• URL ตัวแสดงผลของ Gateway สำหรับการนำเสนอแบบแคนวาส
• พาธไฟล์ที่เรนเดอร์แล้ว (PNG หรือ PDF) สำหรับการส่งผ่านข้อความ
• เอาต์พุตทั้งสองแบบในการเรียกครั้งเดียว

เมื่อเปิดใช้งาน Plugin นี้จะเติมคำแนะนำการใช้งานแบบกระชับไว้ในพื้นที่ system-prompt และยังเปิดเผย Skill แบบละเอียดสำหรับกรณีที่เอเจนต์ต้องการคำแนะนำที่ครบถ้วนกว่า

เริ่มต้นอย่างรวดเร็ว

openclaw plugins install diffs

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

ปิดใช้งานคำแนะนำระบบในตัว

หากคุณต้องการเปิดใช้เครื่องมือ diffs ต่อไปแต่ปิดใช้งานคำแนะนำ system-prompt ในตัว ให้ตั้งค่า plugins.entries.diffs.hooks.allowPromptInjection เป็น false:

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

การตั้งค่านี้จะบล็อกฮุก before_prompt_build ของ Plugin diffs โดยยังคงให้ Plugin เครื่องมือ และ Skill คู่กันพร้อมใช้งาน

หากคุณต้องการปิดใช้งานทั้งคำแนะนำและเครื่องมือ ให้ปิดใช้งาน Plugin แทน

เวิร์กโฟลว์เอเจนต์ทั่วไป

ตัวอย่างอินพุต

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

เอกสารอ้างอิงอินพุตของเครื่องมือ

ทุกฟิลด์เป็นแบบไม่บังคับ เว้นแต่จะระบุไว้

สัญญารายละเอียดเอาต์พุต

เครื่องมือส่งคืนเมทาดาทาแบบมีโครงสร้างภายใต้ details

สรุปพฤติกรรมของโหมด:

ส่วนที่ไม่เปลี่ยนแปลงซึ่งถูกยุบไว้

• ตัวแสดงผลสามารถแสดงแถวเช่น N unmodified lines
• ตัวควบคุมขยายบนแถวเหล่านั้นมีเงื่อนไข และไม่รับประกันว่าจะมีสำหรับอินพุตทุกชนิด
• ตัวควบคุมขยายจะปรากฏเมื่อ diff ที่เรนเดอร์มีข้อมูลบริบทที่ขยายได้ ซึ่งเป็นเรื่องปกติสำหรับอินพุตก่อนและหลัง
• สำหรับอินพุต unified patch จำนวนมาก เนื้อหาบริบทที่ละไว้จะไม่มีอยู่ใน hunk ของ patch ที่แยกวิเคราะห์แล้ว ดังนั้นแถวอาจปรากฏโดยไม่มีตัวควบคุมขยาย นี่เป็นพฤติกรรมที่คาดไว้
• 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 อาร์ติแฟกต์แบบสุ่ม (อักขระ hex 20 ตัว)
  • โทเค็นแบบสุ่ม (อักขระ hex 48 ตัว)
  • createdAt และ expiresAt
  • พาธ viewer.html ที่จัดเก็บไว้
• TTL เริ่มต้นของอาร์ติแฟกต์คือ 30 นาทีเมื่อไม่ได้ระบุ
• TTL ของตัวแสดงผลสูงสุดที่ยอมรับคือ 6 ชั่วโมง
• การล้างข้อมูลทำงานตามโอกาสหลังจากสร้างอาร์ติแฟกต์
• อาร์ติแฟกต์ที่หมดอายุจะถูกลบ
• การล้างข้อมูลสำรองจะลบโฟลเดอร์เก่าที่เก่ากว่า 24 ชั่วโมงเมื่อไม่มีเมทาดาทา

URL ตัวแสดงผลและพฤติกรรมเครือข่าย

Route ของตัวแสดงผล:

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

แอสเซ็ตของตัวแสดงผล:

• /plugins/diffs/assets/viewer.js
• /plugins/diffs/assets/viewer-runtime.js

เอกสารตัวแสดงผล resolve แอสเซ็ตเหล่านั้นโดยอิงกับ URL ของตัวแสดงผล ดังนั้น prefix พาธ baseUrl แบบไม่บังคับจะถูกคงไว้สำหรับคำขอแอสเซ็ตทั้งสองรายการด้วย

พฤติกรรมการสร้าง URL:

• หากระบุ baseUrl ในการเรียกเครื่องมือ ระบบจะใช้ค่านั้นหลังจากตรวจสอบอย่างเข้มงวด
• มิฉะนั้น หากกำหนดค่า viewerBaseUrl ของ Plugin ไว้ ระบบจะใช้ค่านั้น
• หากไม่มีค่าแทนที่ทั้งสองแบบ URL ตัวแสดงผลจะมีค่าเริ่มต้นเป็น loopback 127.0.0.1
• หากโหมด bind ของ Gateway เป็น custom และตั้งค่า gateway.customBindHost ไว้ ระบบจะใช้ host นั้น

กฎของ 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" สำหรับการรีวิวแบบโต้ตอบภายในเครื่องในแคนวาส
• ควรใช้ mode: "file" สำหรับช่องแชตขาออกที่ต้องใช้ไฟล์แนบ
• ปิดใช้ allowRemoteViewer ไว้ เว้นแต่การปรับใช้ของคุณต้องใช้ URL ของ Viewer ระยะไกล
• ตั้งค่า ttlSeconds แบบสั้นอย่างชัดเจนสำหรับ diff ที่ละเอียดอ่อน
• หลีกเลี่ยงการส่งข้อมูลลับในอินพุต diff เมื่อไม่จำเป็น
• หากช่องของคุณบีบอัดรูปภาพอย่างรุนแรง (ตัวอย่างเช่น Telegram หรือ WhatsApp) ควรใช้เอาต์พุต PDF (fileFormat: "pdf")

ที่เกี่ยวข้อง

• เบราว์เซอร์
• Plugin
• ภาพรวมเครื่องมือ