​

Points d’entrée de Plugin

{
  "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 doit correspondre à votre manifeste openclaw.plugin.json.
• kind est destiné aux emplacements exclusifs : "memory" ou "context-engine".
• configSchema peut être une fonction pour une évaluation paresseuse.
• OpenClaw résout et met en cache ce schéma au premier accès, de sorte que les constructeurs de schéma coûteux ne s’exécutent qu’une seule fois.

​

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 est appelé pendant l’enregistrement afin que vous puissiez stocker la référence d’exécution (généralement via createPluginRuntimeStore). Il est ignoré pendant la capture des métadonnées CLI.
• registerCliMetadata s’exécute à la fois pendant api.registrationMode === "cli-metadata" et api.registrationMode === "full". Utilisez-le comme emplacement canonique pour les descripteurs CLI appartenant au canal afin que l’aide racine reste non activante tout en conservant la compatibilité avec l’enregistrement normal des commandes CLI lors des chargements complets de plugin.
• registerFull ne s’exécute que lorsque api.registrationMode === "full". Il est ignoré pendant le chargement configuration initiale uniquement.
• Comme definePluginEntry, configSchema peut être une fabrique paresseuse et OpenClaw met en cache le schéma résolu au premier accès.
• Pour les commandes CLI racine appartenant au plugin, préférez api.registerCli(..., { descriptors: [...] }) lorsque vous voulez que la commande reste chargée paresseusement sans disparaître de l’arbre d’analyse de la CLI racine. Pour les plugins de canal, préférez enregistrer ces descripteurs depuis registerCliMetadata(...) et gardez registerFull(...) centré sur le travail réservé à l’exécution.
• Si registerFull(...) enregistre aussi des méthodes RPC Gateway, gardez-les sur un préfixe propre au plugin. Les espaces de noms d’administration centraux réservés (config.*, exec.approvals.*, wizard.*, update.*) sont toujours forcés vers operator.admin.

​

defineSetupPluginEntry

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

export default defineSetupPluginEntry(myChannelPlugin);

• openclaw/plugin-sdk/setup-runtime pour les helpers de configuration initiale sûrs à l’exécution tels que les adaptateurs de patch de configuration initiale import-safe, la sortie de note de recherche, promptResolvedAllowFrom, splitSetupEntries, et les proxys de configuration initiale délégués
• openclaw/plugin-sdk/channel-setup pour les surfaces de configuration initiale à installation facultative
• openclaw/plugin-sdk/setup-tools pour les helpers CLI/archive/docs de configuration initiale et d’installation

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

​

Mode d’enregistrement

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

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

  // Enregistrements lourds réservés à l’exécution
  api.registerService(/* ... */);
}

• utilisez descriptors lorsque l’enregistreur possède une ou plusieurs commandes racine et que vous voulez qu’OpenClaw charge paresseusement le vrai module CLI à la première invocation
• assurez-vous que ces descripteurs couvrent chaque racine de commande de premier niveau exposée par l’ enregistreur
• utilisez commands seul uniquement pour les chemins de compatibilité eager

​

Formes de plugin

​

Liens associés

• Vue d’ensemble du SDK — API d’enregistrement et référence des sous-chemins
• Helpers d’exécution — api.runtime et createPluginRuntimeStore
• Configuration initiale et configuration — manifeste, point d’entrée de configuration initiale, chargement différé
• Plugins de canal — construction de l’objet ChannelPlugin
• Plugins de fournisseur — enregistrement des fournisseurs et hooks