ความแตกต่าง

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

รองรับอินพุตได้ทั้ง:

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

สามารถส่งคืนได้:

• URL ตัวแสดงผลของ Gateway สำหรับการนำเสนอผ่าน canvas
• พาธไฟล์ที่เรนเดอร์แล้ว (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,
        },
      },
    },
  },
}

การตั้งค่านี้บล็อก hook 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 จำนวนมาก เนื้อหาบริบทที่ละไว้ไม่มีอยู่ใน patch hunks ที่แยกวิเคราะห์แล้ว ดังนั้นแถวอาจปรากฏโดยไม่มีปุ่มควบคุมการขยาย นี่เป็นพฤติกรรมที่คาดไว้
• 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",
          },
        },
      },
    },
  },
}

ค่าเริ่มต้นที่รองรับ:

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

พารามิเตอร์เครื่องมือที่ระบุอย่างชัดเจนจะแทนที่ค่าเริ่มต้นเหล่านี้

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

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

เส้นทางตัวแสดงผล:

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

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

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

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

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

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

กฎของ 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")

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

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