Các điểm vào của Plugin

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.

{
  "openclaw": {
    "extensions": ["./src/index.ts"],
    "runtimeExtensions": ["./dist/index.js"],
    "setupEntry": "./src/setup-entry.ts",
    "runtimeSetupEntry": "./dist/setup-entry.js"
  }
}

​

definePluginEntry

import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";

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

• id phải khớp với manifest openclaw.plugin.json của bạn.
• kind dùng cho các slot độc quyền: "memory" hoặc "context-engine".
• configSchema có thể là một hàm để đánh giá lười.
• OpenClaw phân giải và ghi nhớ schema đó trong lần truy cập đầu tiên, nên các builder schema tốn kém chỉ chạy một lần.

​

defineChannelPluginEntry

import { defineChannelPluginEntry } from "openclaw/plugin-sdk/channel-core";

export default defineChannelPluginEntry({
  id: "my-channel",
  name: "My Channel",
  description: "Short summary",
  plugin: myChannelPlugin,
  setRuntime: setMyRuntime,
  registerCliMetadata(api) {
    api.registerCli(/* ... */);
  },
  registerFull(api) {
    api.registerGatewayMethod(/* ... */);
  },
});

• setRuntime được gọi trong quá trình đăng ký để bạn có thể lưu tham chiếu runtime (thường qua createPluginRuntimeStore). Nó được bỏ qua trong quá trình thu thập metadata CLI.
• registerCliMetadata chạy trong api.registrationMode === "cli-metadata", api.registrationMode === "discovery" và api.registrationMode === "full". Dùng nó làm nơi chuẩn cho các descriptor CLI thuộc sở hữu kênh để root help không kích hoạt, snapshot khám phá bao gồm metadata lệnh tĩnh, và đăng ký lệnh CLI thông thường vẫn tương thích với các lần tải Plugin đầy đủ.
• Đăng ký khám phá là không kích hoạt, không phải không import. OpenClaw có thể đánh giá entry Plugin tin cậy và module Plugin kênh để build snapshot, vì vậy hãy giữ các import cấp cao nhất không có side effect và đặt socket, client, worker và service phía sau các đường dẫn chỉ dành cho "full".
• registerFull chỉ chạy khi api.registrationMode === "full". Nó bị bỏ qua trong quá trình tải chỉ setup.
• Giống như definePluginEntry, configSchema có thể là một factory lười và OpenClaw ghi nhớ schema đã phân giải trong lần truy cập đầu tiên.
• Đối với các lệnh CLI root thuộc sở hữu Plugin, hãy ưu tiên api.registerCli(..., { descriptors: [...] }) khi bạn muốn lệnh vẫn được tải lười mà không biến mất khỏi cây phân tích CLI root. Đối với các lệnh tính năng paired-node, hãy ưu tiên api.registerNodeCliFeature(...) để lệnh nằm dưới openclaw nodes. Đối với các lệnh Plugin lồng nhau khác, thêm parentPath và đăng ký lệnh trên đối tượng program được truyền cho registrar; OpenClaw phân giải nó thành lệnh cha trước khi gọi Plugin. Đối với Plugin kênh, hãy ưu tiên đăng ký các descriptor đó từ registerCliMetadata(...) và giữ registerFull(...) tập trung vào công việc chỉ dành cho runtime.
• Nếu registerFull(...) cũng đăng ký các phương thức RPC Gateway, hãy giữ chúng trên một tiền tố dành riêng cho Plugin. Các namespace quản trị lõi dành riêng (config.*, exec.approvals.*, wizard.*, update.*) luôn bị ép thành operator.admin.

​

defineSetupPluginEntry

import { defineSetupPluginEntry } from "openclaw/plugin-sdk/channel-core";

export default defineSetupPluginEntry(myChannelPlugin);

• openclaw/plugin-sdk/setup-runtime cho các helper setup an toàn runtime như adapter patch setup an toàn khi import, đầu ra ghi chú tra cứu, promptResolvedAllowFrom, splitSetupEntries và proxy setup được ủy quyền
• openclaw/plugin-sdk/channel-setup cho các bề mặt setup cài đặt tùy chọn
• openclaw/plugin-sdk/setup-tools cho các helper CLI/archive/docs setup/cài đặt

import { defineBundledChannelSetupEntry } from "openclaw/plugin-sdk/channel-entry-contract";

export default defineBundledChannelSetupEntry({
  importMetaUrl: import.meta.url,
  plugin: {
    specifier: "./channel-plugin-api.js",
    exportName: "myChannelPlugin",
  },
  runtime: {
    specifier: "./runtime-api.js",
    exportName: "setMyChannelRuntime",
  },
});

​

Chế độ đăng ký

register(api) {
  if (
    api.registrationMode === "cli-metadata" ||
    api.registrationMode === "discovery" ||
    api.registrationMode === "full"
  ) {
    api.registerCli(/* ... */);
    if (api.registrationMode === "cli-metadata") return;
  }

  api.registerChannel({ plugin: myPlugin });
  if (api.registrationMode !== "full") return;

  // Heavy runtime-only registrations
  api.registerService(/* ... */);
}

• dùng descriptors khi registrar sở hữu một hoặc nhiều lệnh gốc và bạn muốn OpenClaw tải mô-đun CLI thực sự khi được gọi lần đầu
• đảm bảo các descriptor đó bao phủ mọi gốc lệnh cấp cao nhất do registrar cung cấp
• giữ tên lệnh descriptor chỉ gồm chữ cái, chữ số, dấu gạch nối và dấu gạch dưới, bắt đầu bằng chữ cái hoặc chữ số; OpenClaw từ chối tên descriptor nằm ngoài dạng đó và loại bỏ các chuỗi điều khiển terminal khỏi phần mô tả trước khi hiển thị trợ giúp
• chỉ dùng riêng commands cho các đường dẫn tương thích tải ngay

​

Kiểu Plugin

​

Liên quan

• Tổng quan SDK - API đăng ký và tham chiếu subpath
• Trình trợ giúp runtime - api.runtime và createPluginRuntimeStore
• Thiết lập và cấu hình - manifest, mục nhập thiết lập, tải trì hoãn
• Plugin kênh - xây dựng đối tượng ChannelPlugin
• Plugin provider - đăng ký provider và hook