Plugin-ingangspunten

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 moet overeenkomen met je openclaw.plugin.json-manifest.
• kind is voor exclusieve slots: "memory" of "context-engine".
• configSchema kan een functie zijn voor luie evaluatie.
• OpenClaw lost dat schema op en memoiseert het bij de eerste toegang, zodat dure schema- builders maar een keer worden uitgevoerd.

​

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 wordt aangeroepen tijdens registratie zodat je de runtimeverwijzing kunt opslaan (meestal via createPluginRuntimeStore). Dit wordt overgeslagen tijdens het vastleggen van CLI-metadata.
• registerCliMetadata wordt uitgevoerd tijdens api.registrationMode === "cli-metadata", api.registrationMode === "discovery" en api.registrationMode === "full". Gebruik dit als de canonieke plek voor kanaaleigen CLI-descriptors, zodat root-help niet-activerend blijft, discovery-snapshots statische commandmetadata bevatten en normale CLI-commandregistratie compatibel blijft met volledige pluginladingen.
• Discovery-registratie is niet-activerend, niet importvrij. OpenClaw kan de vertrouwde plugin-entry en kanaalpluginmodule evalueren om de snapshot te bouwen, dus houd imports op topniveau vrij van side-effects en plaats sockets, clients, workers en services achter paden die alleen voor "full" zijn.
• registerFull wordt alleen uitgevoerd wanneer api.registrationMode === "full". Dit wordt overgeslagen tijdens setup-only laden.
• Net als definePluginEntry kan configSchema een luie factory zijn en memoiseert OpenClaw het opgeloste schema bij de eerste toegang.
• Voor plugineigen root-CLI-commands geef je de voorkeur aan api.registerCli(..., { descriptors: [...] }) wanneer je wilt dat het command lazy-loaded blijft zonder uit de root-CLI-parse tree te verdwijnen. Voor featurecommands met gekoppelde nodes geef je de voorkeur aan api.registerNodeCliFeature(...) zodat het command onder openclaw nodes terechtkomt. Voor andere geneste plugincommands voeg je parentPath toe en registreer je commands op het program-object dat aan de registrar wordt doorgegeven; OpenClaw lost dit op naar het parent-command voordat de plugin wordt aangeroepen. Voor kanaalplugins geef je de voorkeur aan het registreren van die descriptors vanuit registerCliMetadata(...) en houd je registerFull(...) gericht op werk dat alleen runtime is.
• Als registerFull(...) ook Gateway-RPC-methoden registreert, houd die dan op een pluginspecifiek prefix. Gereserveerde core-admin-namespaces (config.*, exec.approvals.*, wizard.*, update.*) worden altijd afgedwongen naar operator.admin.

​

defineSetupPluginEntry

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

export default defineSetupPluginEntry(myChannelPlugin);

• openclaw/plugin-sdk/setup-runtime voor runtime-veilige setuphelpers zoals importveilige setup-patchadapters, lookup-note-output, promptResolvedAllowFrom, splitSetupEntries en gedelegeerde setup-proxy’s
• openclaw/plugin-sdk/channel-setup voor optional-install setupoppervlakken
• openclaw/plugin-sdk/setup-tools voor setup/install CLI/archive/docs-helpers

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",
  },
});

​

Registratiemodus

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(/* ... */);
}

• gebruik descriptors wanneer de registrar eigenaar is van een of meer rootopdrachten en je wilt dat OpenClaw de echte CLI-module lazy-loadt bij de eerste aanroep
• zorg ervoor dat die descriptors elke root van een top-level opdracht dekken die door de registrar wordt blootgesteld
• beperk descriptornamen voor opdrachten tot letters, cijfers, koppeltekens en underscores, beginnend met een letter of cijfer; OpenClaw weigert descriptornamen buiten die vorm en verwijdert terminalbesturingsreeksen uit beschrijvingen voordat hulp wordt weergegeven
• gebruik commands alleen voor eager compatibiliteitspaden

​

Plugin-vormen

​

Gerelateerd

• SDK-overzicht - registratie-API en subpadreferentie
• Runtime-helpers - api.runtime en createPluginRuntimeStore
• Installatie en configuratie - manifest, setup-entry, uitgesteld laden
• Kanaal-Plugins - het ChannelPlugin-object bouwen
• Provider-Plugins - providerregistratie en hooks