Installation et configuration du Plugin

Référence pour le packaging de Plugin (métadonnées package.json), les manifestes (openclaw.plugin.json), les entrées de configuration initiale et les schémas de configuration.

Métadonnées de package

Votre package.json doit contenir un champ openclaw qui indique au système de Plugins ce que fournit votre Plugin :

{  "name": "@myorg/openclaw-my-channel",  "version": "1.0.0",  "type": "module",  "openclaw": {    "extensions": ["./index.ts"],    "setupEntry": "./setup-entry.ts",    "channel": {      "id": "my-channel",      "label": "My Channel",      "blurb": "Short description of the channel."    }  }}

{  "name": "@myorg/openclaw-my-plugin",  "version": "1.0.0",  "type": "module",  "dependencies": {    "typebox": "1.1.39"  },  "peerDependencies": {    "openclaw": ">=2026.3.24-beta.2"  },  "openclaw": {    "extensions": ["./index.ts"],    "compat": {      "pluginApi": ">=2026.3.24-beta.2",      "minGatewayVersion": "2026.3.24-beta.2"    },    "build": {      "openclawVersion": "2026.3.24-beta.2",      "pluginSdkVersion": "2026.3.24-beta.2"    }  }}

Champs openclaw

openclaw.channel

openclaw.channel correspond à des métadonnées de package peu coûteuses pour la découverte des canaux et les surfaces de configuration initiale avant le chargement du runtime.

Exemple :

{  "openclaw": {    "channel": {      "id": "my-channel",      "label": "My Channel",      "selectionLabel": "My Channel (self-hosted)",      "detailLabel": "My Channel Bot",      "docsPath": "/channels/my-channel",      "docsLabel": "my-channel",      "blurb": "Webhook-based self-hosted chat integration.",      "order": 80,      "aliases": ["mc"],      "preferOver": ["my-channel-legacy"],      "selectionDocsPrefix": "Guide:",      "selectionExtras": ["Markdown"],      "markdownCapable": true,      "exposure": {        "configured": true,        "setup": true,        "docs": true      },      "quickstartAllowFrom": true    }  }}

exposure prend en charge :

• configured : inclure le canal dans les surfaces de liste de type configuré/état
• setup : inclure le canal dans les sélecteurs interactifs de configuration initiale/configuration
• docs : marquer le canal comme public dans les surfaces de documentation/navigation

openclaw.install

openclaw.install correspond à des métadonnées de package, pas à des métadonnées de manifeste.

{  "openclaw": {    "install": {      "npmSpec": "@wecom/wecom-openclaw-plugin@1.2.3",      "expectedIntegrity": "sha512-REPLACE_WITH_NPM_DIST_INTEGRITY",      "defaultChoice": "npm"    }  }}

Chargement complet différé

Les Plugins de canal peuvent opter pour le chargement différé avec :

{  "openclaw": {    "extensions": ["./index.ts"],    "setupEntry": "./setup-entry.ts",    "startup": {      "deferConfiguredChannelFullLoadUntilAfterListen": true    }  }}

Lorsque cette option est activée, OpenClaw charge uniquement setupEntry pendant la phase de démarrage avant écoute, même pour les canaux déjà configurés. L’entrée complète se charge après que le Gateway commence à écouter.

Si votre entrée de configuration initiale/complète enregistre des méthodes RPC du Gateway, gardez-les sur un préfixe propre au Plugin. Les espaces de noms d’administration centrale réservés (config.*, exec.approvals.*, wizard.*, update.*) restent détenus par le cœur et se résolvent toujours vers operator.admin.

Manifeste de Plugin

Chaque Plugin natif doit fournir un openclaw.plugin.json à la racine du package. OpenClaw l’utilise pour valider la configuration sans exécuter le code du Plugin.

{  "id": "my-plugin",  "name": "My Plugin",  "description": "Adds My Plugin capabilities to OpenClaw",  "configSchema": {    "type": "object",    "additionalProperties": false,    "properties": {      "webhookSecret": {        "type": "string",        "description": "Webhook verification secret"      }    }  }}

Pour les Plugins de canal, ajoutez kind et channels :

{  "id": "my-channel",  "kind": "channel",  "channels": ["my-channel"],  "configSchema": {    "type": "object",    "additionalProperties": false,    "properties": {}  }}

Même les plugins sans configuration doivent livrer un schéma. Un schéma vide est valide :

{  "id": "my-plugin",  "configSchema": {    "type": "object",    "additionalProperties": false  }}

Consultez Manifeste de Plugin pour la référence complète du schéma.

Publication ClawHub

Pour les packages de plugins, utilisez la commande ClawHub propre au package :

clawhub package publish your-org/your-plugin --dry-runclawhub package publish your-org/your-plugin

Point d’entrée de configuration

Le fichier setup-entry.ts est une alternative légère à index.ts qu’OpenClaw charge lorsqu’il n’a besoin que des surfaces de configuration (intégration, réparation de configuration, inspection des canaux désactivés).

// setup-entry.ts  export default defineSetupPluginEntry(myChannelPlugin);

Cela évite de charger du code d’exécution lourd (bibliothèques de chiffrement, enregistrements CLI, services d’arrière-plan) pendant les flux de configuration.

Les canaux d’espace de travail groupés qui conservent des exports compatibles avec la configuration dans des modules annexes peuvent utiliser defineBundledChannelSetupEntry(...) depuis openclaw/plugin-sdk/channel-entry-contract au lieu de defineSetupPluginEntry(...). Ce contrat groupé prend aussi en charge un export runtime facultatif afin que le câblage d’exécution au moment de la configuration reste léger et explicite.

Imports étroits des assistants de configuration

Pour les chemins chauds uniquement liés à la configuration, préférez les surfaces étroites d’assistants de configuration au module global plus large plugin-sdk/setup lorsque vous n’avez besoin que d’une partie de la surface de configuration :

Utilisez la surface plus large plugin-sdk/setup lorsque vous voulez la boîte à outils de configuration partagée complète, y compris les assistants de correctifs de configuration tels que moveSingleAccountChannelSectionToDefaultAccount(...).

Utilisez createSetupTranslator(...) pour les textes fixes de l’assistant de configuration. Il suit la locale de l’assistant CLI (OPENCLAW_LOCALE, puis les variables de locale du système) et revient à l’anglais par défaut. Conservez le texte de configuration propre au plugin dans le code appartenant au plugin et utilisez les clés de catalogue partagées uniquement pour les libellés de configuration communs, le texte d’état et le texte de configuration des plugins groupés officiels.

Les adaptateurs de correctifs de configuration restent sûrs à importer dans les chemins chauds. Leur recherche de surface de contrat de promotion groupée à compte unique est paresseuse, donc importer plugin-sdk/setup-runtime ne charge pas avidement la découverte des surfaces de contrat groupées avant que l’adaptateur ne soit réellement utilisé.

Promotion de compte unique appartenant au canal

Lorsqu’un canal passe d’une configuration de premier niveau à compte unique à channels.<id>.accounts.*, le comportement partagé par défaut consiste à déplacer les valeurs promues liées au compte dans accounts.default.

Les canaux groupés peuvent restreindre ou remplacer cette promotion via leur surface de contrat de configuration :

• singleAccountKeysToMove : clés de premier niveau supplémentaires qui doivent être déplacées dans le compte promu
• namedAccountPromotionKeys : lorsque des comptes nommés existent déjà, seules ces clés sont déplacées dans le compte promu ; les clés de stratégie/livraison partagées restent à la racine du canal
• resolveSingleAccountPromotionTarget(...) : choisir quel compte existant reçoit les valeurs promues

Schéma de configuration

La configuration du plugin est validée avec le JSON Schema dans votre manifeste. Les utilisateurs configurent les plugins via :

{  plugins: {    entries: {      "my-plugin": {        config: {          webhookSecret: "abc123",        },      },    },  },}

Votre plugin reçoit cette configuration sous la forme api.pluginConfig pendant l’enregistrement.

Pour une configuration propre à un canal, utilisez plutôt la section de configuration du canal :

{  channels: {    "my-channel": {      token: "bot-token",      allowFrom: ["user1", "user2"],    },  },}

Construction de schémas de configuration de canal

Utilisez buildChannelConfigSchema pour convertir un schéma Zod en enveloppe ChannelConfigSchema utilisée par les artefacts de configuration appartenant au plugin :

  const accountSchema = z.object({  token: z.string().optional(),  allowFrom: z.array(z.string()).optional(),  accounts: z.object({}).catchall(z.any()).optional(),  defaultAccount: z.string().optional(),}); const configSchema = buildChannelConfigSchema(accountSchema);

Si vous rédigez déjà le contrat en JSON Schema ou TypeBox, utilisez l’assistant direct afin qu’OpenClaw puisse ignorer la conversion Zod vers JSON Schema sur les chemins de métadonnées :

  const configSchema = buildJsonChannelConfigSchema(  Type.Object({    token: Type.Optional(Type.String()),    allowFrom: Type.Optional(Type.Array(Type.String())),  }),);

Pour les plugins tiers, le contrat du chemin froid reste le manifeste du plugin : reproduisez le JSON Schema généré dans openclaw.plugin.json#channelConfigs afin que les surfaces de schéma de configuration, de configuration et d’interface puissent inspecter channels.<id> sans charger le code d’exécution.

Assistants de configuration

Les plugins de canal peuvent fournir des assistants de configuration interactifs pour openclaw onboard. L’assistant est un objet ChannelSetupWizard sur le ChannelPlugin :

 const setupWizard: ChannelSetupWizard = {  channel: "my-channel",  status: {    configuredLabel: "Connected",    unconfiguredLabel: "Not configured",    resolveConfigured: ({ cfg }) => Boolean((cfg.channels as any)?.["my-channel"]?.token),  },  credentials: [    {      inputKey: "token",      providerHint: "my-channel",      credentialLabel: "Bot token",      preferredEnvVar: "MY_CHANNEL_BOT_TOKEN",      envPrompt: "Use MY_CHANNEL_BOT_TOKEN from environment?",      keepPrompt: "Keep current token?",      inputPrompt: "Enter your bot token:",      inspect: ({ cfg, accountId }) => {        const token = (cfg.channels as any)?.["my-channel"]?.token;        return {          accountConfigured: Boolean(token),          hasConfiguredValue: Boolean(token),        };      },    },  ],};

Le type ChannelSetupWizard prend en charge credentials, textInputs, dmPolicy, allowFrom, groupAccess, prepare, finalize, et plus encore. Consultez les packages de plugins groupés (par exemple le plugin Discord src/channel.setup.ts) pour des exemples complets.

import { createOptionalChannelSetupSurface } from "openclaw/plugin-sdk/channel-setup"; const setupSurface = createOptionalChannelSetupSurface({  channel: "my-channel",  label: "My Channel",  npmSpec: "@myorg/openclaw-my-channel",  docsPath: "/channels/my-channel",});// Returns { setupAdapter, setupWizard }

Publication et installation

Plugins externes : publiez sur ClawHub, puis installez :

openclaw plugins install @myorg/openclaw-my-plugin

openclaw plugins install clawhub:@myorg/openclaw-my-plugin

openclaw plugins install npm:@myorg/openclaw-my-plugin

Plugins dans le dépôt : placez-les sous l’arborescence de l’espace de travail des plugins intégrés ; ils seront automatiquement découverts pendant la compilation.

Les utilisateurs peuvent installer :

openclaw plugins install <package-name>

Les métadonnées des paquets intégrés sont explicites, et non déduites du JavaScript compilé au démarrage du Gateway. Les dépendances d’exécution appartiennent au paquet de plugin qui les possède ; le démarrage d’OpenClaw empaqueté ne répare ni ne duplique jamais les dépendances des plugins.

Associé

• Création de plugins — guide de démarrage pas à pas
• Manifeste de plugin — référence complète du schéma de manifeste
• Points d’entrée du SDK — definePluginEntry et defineChannelPluginEntry