Plugin-Einstiegspunkte

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 muss Ihrem openclaw.plugin.json-Manifest entsprechen.
• kind ist für exklusive Slots: "memory" oder "context-engine".
• configSchema kann eine Funktion für Lazy-Evaluation sein.
• OpenClaw löst dieses Schema beim ersten Zugriff auf und memoisiert es, sodass aufwendige Schema-Builder nur einmal ausgeführt werden.

​

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 wird während der Registrierung aufgerufen, damit Sie die Runtime-Referenz speichern können (typischerweise über createPluginRuntimeStore). Während der Erfassung von CLI-Metadaten wird es übersprungen.
• registerCliMetadata läuft während api.registrationMode === "cli-metadata", api.registrationMode === "discovery" und api.registrationMode === "full". Verwenden Sie es als kanonischen Ort für channel-eigene CLI-Deskriptoren, damit die Root-Hilfe nicht aktivierend bleibt, Discovery-Snapshots statische Befehlsmetadaten enthalten und die normale CLI-Befehlsregistrierung mit vollständigen Plugin-Ladevorgängen kompatibel bleibt.
• Discovery-Registrierung ist nicht aktivierend, aber nicht importfrei. OpenClaw kann den vertrauenswürdigen Plugin-Entry und das Channel-Plugin-Modul auswerten, um den Snapshot zu erstellen. Halten Sie daher Top-Level-Imports frei von Seiteneffekten und legen Sie Sockets, Clients, Worker und Dienste hinter Pfade, die nur für "full" verwendet werden.
• registerFull läuft nur, wenn api.registrationMode === "full". Während setup-only-Laden wird es übersprungen.
• Wie bei definePluginEntry kann configSchema eine Lazy-Factory sein, und OpenClaw memoisiert das aufgelöste Schema beim ersten Zugriff.
• Für Plugin-eigene Root-CLI-Befehle bevorzugen Sie api.registerCli(..., { descriptors: [...] }), wenn der Befehl lazy-loaded bleiben soll, ohne aus dem Root-CLI-Parse-Baum zu verschwinden. Für Paired-Node-Feature-Befehle bevorzugen Sie api.registerNodeCliFeature(...), damit der Befehl unter openclaw nodes landet. Für andere verschachtelte Plugin-Befehle fügen Sie parentPath hinzu und registrieren Befehle am program-Objekt, das an den Registrar übergeben wird; OpenClaw löst es vor dem Aufruf des Plugins zum übergeordneten Befehl auf. Für Channel-Plugins bevorzugen Sie, diese Deskriptoren aus registerCliMetadata(...) zu registrieren, und halten Sie registerFull(...) auf reine Runtime-Arbeit fokussiert.
• Wenn registerFull(...) auch Gateway-RPC-Methoden registriert, behalten Sie sie auf einem Plugin-spezifischen Präfix. Reservierte Core-Admin-Namespaces (config.*, exec.approvals.*, wizard.*, update.*) werden immer zu operator.admin erzwungen.

​

defineSetupPluginEntry

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

export default defineSetupPluginEntry(myChannelPlugin);

• openclaw/plugin-sdk/setup-runtime für runtime-sichere Setup-Hilfsfunktionen wie importsichere Setup-Patch-Adapter, Lookup-Note-Ausgabe, promptResolvedAllowFrom, splitSetupEntries und delegierte Setup-Proxys
• openclaw/plugin-sdk/channel-setup für Setup-Oberflächen für optionale Installation
• openclaw/plugin-sdk/setup-tools für Setup-/Installations-CLI-/Archiv-/Dokumentationshilfen

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

​

Registrierungsmodus

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

• verwenden Sie descriptors, wenn der Registrar einen oder mehrere Root-Befehle besitzt und Sie möchten, dass OpenClaw das eigentliche CLI-Modul beim ersten Aufruf per Lazy Loading lädt
• stellen Sie sicher, dass diese Deskriptoren jeden Top-Level-Command-Root abdecken, den der Registrar bereitstellt
• beschränken Sie Deskriptor-Befehlsnamen auf Buchstaben, Zahlen, Bindestrich und Unterstrich, beginnend mit einem Buchstaben oder einer Zahl; OpenClaw weist Deskriptor-Namen außerhalb dieser Form zurück und entfernt Terminal-Steuersequenzen aus Beschreibungen, bevor die Hilfe gerendert wird
• verwenden Sie commands allein nur für Kompatibilitätspfade mit eager loading

​

Plugin-Formen

​

Verwandt

• SDK-Überblick - Registrierungs-API und Subpfad-Referenz
• Runtime Helpers - api.runtime und createPluginRuntimeStore
• Einrichtung und Konfiguration - Manifest, Einrichtungseinstieg, verzögertes Laden
• Channel Plugins - Erstellen des ChannelPlugin-Objekts
• Provider Plugins - Provider-Registrierung und Hooks