Điểm vào của 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": {
    "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ành 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, vì vậy các trình xây dựng 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 thời gian chạy (thường thông qua createPluginRuntimeStore). Nó bị bỏ qua trong quá trình thu thập siêu dữ liệu 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 mô tả CLI do kênh sở hữu để trợ giúp gốc không kích hoạt, snapshot khám phá bao gồm siêu dữ liệu lệnh tĩnh, và đăng ký lệnh CLI thông thường vẫn tương thích với tải Plugin đầy đủ.
• Đăng ký khám phá là không kích hoạt, không phải không cần nhập. OpenClaw có thể đánh giá mục nhập Plugin đáng tin cậy và mô-đun Plugin kênh để xây dựng snapshot, vì vậy hãy giữ các import cấp cao nhất không có tác dụng phụ và đặt socket, client, worker và dịch vụ 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 khi tải chỉ dành cho thiết lập.
• Giống 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 gốc do Plugin sở hữu, 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 gốc. Đối với Plugin kênh, hãy ưu tiên đăng ký các mô tả đó từ registerCliMetadata(...) và giữ registerFull(...) tập trung vào công việc chỉ dành cho thời gian chạy.
• 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 được 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 trình trợ giúp thiết lập an toàn với thời gian chạy như bộ điều hợp bản vá thiết lập an toàn khi import, đầu ra ghi chú tra cứu, promptResolvedAllowFrom, splitSetupEntries và proxy thiết lập được ủy quyền
• openclaw/plugin-sdk/channel-setup cho các bề mặt thiết lập cài đặt tùy chọn
• openclaw/plugin-sdk/setup-tools cho các trình trợ giúp CLI/lưu trữ/tài liệu thiết lập/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 trình đăng ký sở hữu một hoặc nhiều lệnh gốc và bạn muốn OpenClaw tải lười mô-đun CLI thật khi gọi lần đầu
• đảm bảo các mô tả đó bao phủ mọi gốc lệnh cấp cao nhất do trình đăng ký để lộ
• giữ tên lệnh trong mô tả 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 mô tả nằm ngoài dạng đó và loại bỏ các chuỗi điều khiển terminal khỏi mô tả trước khi hiển thị trợ giúp
• chỉ dùng commands riêng cho các đường dẫn tương thích tải ngay

​

Hình dạng Plugin

​

Liên quan

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