Plugin

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.

​

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

openclaw plugins list

# Search ClawHub plugins
openclaw plugins search "calendar"

# From ClawHub
openclaw plugins install clawhub:openclaw-codex-app-server

# From npm
openclaw plugins install npm:@acme/openclaw-plugin
openclaw plugins install npm-pack:./openclaw-plugin-1.2.3.tgz

# From git
openclaw plugins install git:github.com/acme/openclaw-plugin@v1.0.0

# From a local directory or archive
openclaw plugins install ./my-plugin
openclaw plugins install ./my-plugin.tgz

openclaw gateway restart

openclaw plugins inspect <plugin-id> --runtime --json

# If the plugin registered a CLI root, run one command from that root.
openclaw <plugin-command> --help

/plugin install clawhub:<package>
/plugin show <plugin-id>
/plugin enable <plugin-id>

​

ความเป็นเจ้าของ path ของ Plugin ที่ถูกบล็อก

sudo chown -R 1000:1000 /path/to/openclaw-config /path/to/openclaw-workspace

sudo chown -R root:root /path/to/openclaw-config/npm

​

ประเภทของ Plugin

​

Entrypoints ของแพ็กเกจ

{
  "name": "@acme/openclaw-plugin",
  "openclaw": {
    "extensions": ["./src/index.ts"],
    "runtimeExtensions": ["./dist/index.js"]
  }
}

​

Plugin ทางการ

​

แพ็กเกจ npm ที่ OpenClaw เป็นเจ้าของระหว่างการย้าย

​

Core (มาพร้อมกับ OpenClaw)

​

การกำหนดค่า

{
  plugins: {
    enabled: true,
    allow: ["voice-call"],
    deny: ["untrusted-plugin"],
    load: { paths: ["~/Projects/oss/voice-call-plugin"] },
    entries: {
      "voice-call": { enabled: true, config: { provider: "twilio" } },
    },
  },
}

​

การค้นพบและลำดับความสำคัญ

​

กฎการเปิดใช้งาน

• plugins.enabled: false ปิดใช้งาน Plugin ทั้งหมดและข้ามงานค้นพบ/โหลด Plugin
• plugins.deny มีลำดับความสำคัญสูงกว่า allow เสมอ
• plugins.entries.\<id\>.enabled: false ปิดใช้งาน Plugin นั้น
• Plugin ที่มาจากเวิร์กสเปซจะ ปิดใช้งานตามค่าเริ่มต้น (ต้องเปิดใช้งานอย่างชัดเจน)
• Plugin แบบบันเดิลทำตามชุดค่าเริ่มต้นที่เปิดอยู่ในตัว เว้นแต่จะถูกแทนที่
• สล็อตแบบเอกสิทธิ์สามารถบังคับเปิดใช้งาน Plugin ที่เลือกสำหรับสล็อตนั้นได้
• Plugin แบบบันเดิลบางตัวที่ต้องเลือกใช้จะเปิดใช้งานโดยอัตโนมัติเมื่อการกำหนดค่าระบุ พื้นผิวที่ Plugin เป็นเจ้าของ เช่น ref โมเดลของผู้ให้บริการ, การกำหนดค่าแชนเนล หรือรันไทม์ harness
• การกำหนดค่า Plugin เก่าจะถูกเก็บรักษาไว้ขณะที่ plugins.enabled: false ทำงานอยู่; เปิดใช้งาน Plugin อีกครั้งก่อนเรียกใช้การล้างข้อมูลของ doctor หากคุณต้องการลบรหัสเก่า
• เส้นทาง Codex ตระกูล OpenAI คงขอบเขต Plugin แยกกัน: openai-codex/* เป็นของ Plugin OpenAI ขณะที่ Plugin app-server Codex แบบบันเดิล จะถูกเลือกโดย ref เอเจนต์ openai/* แบบมาตรฐาน, provider/model agentRuntime.id: "codex" แบบชัดเจน หรือ ref โมเดล codex/* แบบเดิม

​

การแก้ไขปัญหา runtime hooks

• เรียกใช้ openclaw gateway status --deep --require-rpc และยืนยันว่า URL ของ Gateway ที่ใช้งานอยู่, โปรไฟล์, พาธการกำหนดค่า และโปรเซสเป็นรายการที่คุณกำลังแก้ไข
• รีสตาร์ต Gateway จริงหลังจากการเปลี่ยนแปลงการติดตั้ง/การกำหนดค่า/โค้ดของ Plugin ในคอนเทนเนอร์ wrapper PID 1 อาจเป็นเพียง supervisor; รีสตาร์ตหรือส่งสัญญาณไปยังโปรเซสลูก openclaw gateway run
• ใช้ openclaw plugins inspect <id> --runtime --json เพื่อยืนยันการลงทะเบียน hook และ diagnostics hook การสนทนาที่ไม่ใช่แบบบันเดิล เช่น before_model_resolve, before_agent_reply, before_agent_run, llm_input, llm_output, before_agent_finalize และ agent_end ต้องมี plugins.entries.<id>.hooks.allowConversationAccess=true
• สำหรับการสลับโมเดล ควรใช้ before_model_resolve มันทำงานก่อนการแก้โมเดล สำหรับเทิร์นของเอเจนต์; llm_output ทำงานหลังจากความพยายามใช้โมเดล สร้างเอาต์พุตของผู้ช่วยแล้วเท่านั้น
• สำหรับหลักฐานของโมเดลเซสชันที่มีผลจริง ให้ใช้ openclaw sessions หรือพื้นผิว เซสชัน/สถานะของ Gateway และเมื่อดีบักเพย์โหลดผู้ให้บริการ ให้เริ่ม Gateway ด้วย --raw-stream --raw-stream-path <path>

​

การตั้งค่าเครื่องมือ Plugin ช้า

openclaw config set logging.level trace
openclaw logs --follow

[trace:plugin-tools] factory timings ...

openclaw plugins inspect <plugin-id> --runtime --json

​

การเป็นเจ้าของแชนเนลหรือเครื่องมือซ้ำกัน

• channel already registered: <channel-id> (<plugin-id>)
• channel setup already registered: <channel-id> (<plugin-id>)
• plugin tool name conflict (<plugin-id>): <tool-name>

• เรียกใช้ openclaw plugins list --enabled --verbose เพื่อดู Plugin ที่เปิดใช้งานทุกตัว และแหล่งที่มา
• เรียกใช้ openclaw plugins inspect <id> --runtime --json สำหรับ Plugin ที่สงสัยแต่ละตัว และ เปรียบเทียบ channels, channelConfigs, tools และ diagnostics
• เรียกใช้ openclaw plugins registry --refresh หลังจากติดตั้งหรือลบ แพ็กเกจ Plugin เพื่อให้ metadata ที่คงอยู่สะท้อนการติดตั้งปัจจุบัน
• รีสตาร์ต Gateway หลังการเปลี่ยนแปลงการติดตั้ง, รีจิสทรี หรือการกำหนดค่า

• หาก Plugin หนึ่งตั้งใจจะแทนที่อีกตัวสำหรับรหัสแชนเนลเดียวกัน Plugin ที่ต้องการ ควรประกาศ channelConfigs.<channel-id>.preferOver พร้อม รหัส Plugin ที่มีลำดับความสำคัญต่ำกว่า ดู /plugins/manifest#replacing-another-channel-plugin
• หากความซ้ำกันเกิดขึ้นโดยไม่ตั้งใจ ให้ปิดใช้งานด้านหนึ่งด้วย plugins.entries.<plugin-id>.enabled: false หรือลบการติดตั้ง Plugin เก่า
• หากคุณเปิดใช้งานทั้งสอง Plugin อย่างชัดเจน OpenClaw จะคงคำขอนั้นไว้และ รายงานข้อขัดแย้ง เลือกเจ้าของหนึ่งรายสำหรับแชนเนล หรือเปลี่ยนชื่อเครื่องมือที่ Plugin เป็นเจ้าของ เพื่อให้พื้นผิวรันไทม์ไม่กำกวม

​

สล็อต Plugin (หมวดหมู่แบบเอกสิทธิ์)

{
  plugins: {
    slots: {
      memory: "memory-core", // or "none" to disable
      contextEngine: "legacy", // or a plugin id
    },
  },
}

​

ข้อมูลอ้างอิง CLI

openclaw plugins list                       # compact inventory
openclaw plugins list --enabled            # only enabled plugins
openclaw plugins list --verbose            # per-plugin detail lines
openclaw plugins list --json               # machine-readable inventory
openclaw plugins search <query>            # search ClawHub plugin catalog
openclaw plugins inspect <id>              # static detail
openclaw plugins inspect <id> --runtime    # registered hooks/tools/CLI/gateway methods
openclaw plugins inspect <id> --json       # machine-readable
openclaw plugins inspect --all             # fleet-wide table
openclaw plugins info <id>                 # inspect alias
openclaw plugins doctor                    # diagnostics
openclaw plugins registry                  # inspect persisted registry state
openclaw plugins registry --refresh        # rebuild persisted registry
openclaw doctor --fix                      # repair plugin registry state

openclaw plugins install <package>         # install from npm by default
openclaw plugins install clawhub:<pkg>     # install from ClawHub only
openclaw plugins install npm:<pkg>         # install from npm only
openclaw plugins install git:<repo>        # install from git
openclaw plugins install git:<repo>@<ref>  # install from git ref
openclaw plugins install <spec> --force    # overwrite existing install
openclaw plugins install <path>            # install from local path
openclaw plugins install -l <path>         # link (no copy) for dev
openclaw plugins install <plugin> --marketplace <source>
openclaw plugins install <plugin> --marketplace https://github.com/<owner>/<repo>
openclaw plugins install <spec> --pin      # record exact resolved npm spec
openclaw plugins install <spec> --dangerously-force-unsafe-install
openclaw plugins update <id-or-npm-spec> # update one plugin
openclaw plugins update <id-or-npm-spec> --dangerously-force-unsafe-install
openclaw plugins update --all            # update all
openclaw plugins uninstall <id>          # remove config and plugin index records
openclaw plugins uninstall <id> --keep-files
openclaw plugins marketplace list <source>
openclaw plugins marketplace list <source> --json

# Verify runtime registrations after install.
openclaw plugins inspect <id> --runtime --json

# Run plugin-owned CLI commands directly from the OpenClaw root CLI.
openclaw <plugin-command> --help

openclaw plugins enable <id>
openclaw plugins disable <id>

​

ภาพรวม API ของ Plugin

export default definePluginEntry({
  id: "my-plugin",
  name: "My Plugin",
  register(api) {
    api.registerProvider({
      /* ... */
    });
    api.registerTool({
      /* ... */
    });
    api.registerChannel({
      /* ... */
    });
  },
});

• before_tool_call: { block: true } เป็น terminal; handler ที่มี priority ต่ำกว่าจะถูกข้าม
• before_tool_call: { block: false } เป็น no-op และไม่ล้าง block ก่อนหน้า
• before_install: { block: true } เป็น terminal; handler ที่มี priority ต่ำกว่าจะถูกข้าม
• before_install: { block: false } เป็น no-op และไม่ล้าง block ก่อนหน้า
• message_sending: { cancel: true } เป็น terminal; handler ที่มี priority ต่ำกว่าจะถูกข้าม
• message_sending: { cancel: false } เป็น no-op และไม่ล้าง cancel ก่อนหน้า

​

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

• การสร้าง Plugin - สร้าง Plugin ของคุณเอง
• บันเดิล Plugin - ความเข้ากันได้ของบันเดิล Codex/Claude/Cursor
• manifest ของ Plugin - สคีมา manifest
• การลงทะเบียนเครื่องมือ - เพิ่มเครื่องมือเอเจนต์ใน Plugin
• ภายในของ Plugin - โมเดลความสามารถและไปป์ไลน์การโหลด
• ClawHub - การค้นพบ Plugin ของบุคคลที่สาม