package.json), les manifestes (openclaw.plugin.json), les entrées de configuration initiale et les schémas de configuration.
Métadonnées de package
Votrepackage.json doit contenir un champ openclaw qui indique au système de Plugins ce que fournit votre Plugin :
- Channel plugin
- Provider plugin / ClawHub baseline
Si vous publiez le Plugin en externe sur ClawHub, ces champs
compat et build sont obligatoires. Les extraits de publication canoniques se trouvent dans docs/snippets/plugin-publish/.Champs openclaw
Fichiers de point d’entrée (relatifs à la racine du package).
Entrée légère réservée à la configuration initiale (facultative).
Métadonnées du catalogue de canaux pour les surfaces de configuration initiale, de sélection, de démarrage rapide et d’état.
Identifiants de fournisseurs enregistrés par ce Plugin.
Indications d’installation :
npmSpec, localPath, defaultChoice, minHostVersion, expectedIntegrity, allowInvalidConfigRecovery.Indicateurs de comportement au démarrage.
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.
| Champ | Type | Signification |
|---|---|---|
id | string | Identifiant canonique du canal. |
label | string | Libellé principal du canal. |
selectionLabel | string | Libellé de sélection/configuration initiale lorsqu’il doit différer de label. |
detailLabel | string | Libellé de détail secondaire pour des catalogues de canaux et surfaces d’état plus riches. |
docsPath | string | Chemin de documentation pour les liens de configuration initiale et de sélection. |
docsLabel | string | Libellé de remplacement utilisé pour les liens de documentation lorsqu’il doit différer de l’identifiant du canal. |
blurb | string | Brève description d’onboarding/de catalogue. |
order | number | Ordre de tri dans les catalogues de canaux. |
aliases | string[] | Alias de recherche supplémentaires pour la sélection du canal. |
preferOver | string[] | Identifiants de Plugin/canal de priorité inférieure que ce canal doit devancer. |
systemImage | string | Nom facultatif d’icône/image système pour les catalogues d’interface de canaux. |
selectionDocsPrefix | string | Texte de préfixe avant les liens de documentation dans les surfaces de sélection. |
selectionDocsOmitLabel | boolean | Affiche directement le chemin de documentation au lieu d’un lien de documentation libellé dans le texte de sélection. |
selectionExtras | string[] | Courtes chaînes supplémentaires ajoutées au texte de sélection. |
markdownCapable | boolean | Marque le canal comme compatible Markdown pour les décisions de mise en forme sortante. |
exposure | object | Contrôles de visibilité du canal pour la configuration initiale, les listes configurées et les surfaces de documentation. |
quickstartAllowFrom | boolean | Active ce canal dans le flux standard de démarrage rapide allowFrom. |
forceAccountBinding | boolean | Exige une liaison explicite du compte même lorsqu’un seul compte existe. |
preferSessionLookupForAnnounceTarget | boolean | Préfère la recherche de session lors de la résolution des cibles d’annonce pour ce canal. |
exposure prend en charge :
configured: inclure le canal dans les surfaces de liste de type configuré/étatsetup: inclure le canal dans les sélecteurs interactifs de configuration initiale/configurationdocs: marquer le canal comme public dans les surfaces de documentation/navigation
showConfigured et showInSetup restent pris en charge comme alias hérités. Préférez exposure.openclaw.install
openclaw.install correspond à des métadonnées de package, pas à des métadonnées de manifeste.
| Champ | Type | Signification |
|---|---|---|
clawhubSpec | string | Spécification ClawHub canonique pour les flux d’installation/mise à jour et d’installation à la demande lors de l’onboarding. |
npmSpec | string | Spécification npm canonique pour les flux de secours d’installation/mise à jour. |
localPath | string | Chemin d’installation local de développement ou groupé. |
defaultChoice | "clawhub" | "npm" | "local" | Source d’installation préférée lorsque plusieurs sources sont disponibles. |
minHostVersion | string | Version minimale prise en charge d’OpenClaw sous la forme >=x.y.z ou >=x.y.z-prerelease. |
expectedIntegrity | string | Chaîne d’intégrité npm dist attendue, généralement sha512-..., pour les installations épinglées. |
allowInvalidConfigRecovery | boolean | Permet aux flux de réinstallation de Plugins groupés de récupérer après certaines défaillances de configuration obsolète. |
requiredPlatformPackages | string[] | Alias npm propres à la plateforme requis et vérifiés pendant l’installation npm. |
Onboarding behavior
Onboarding behavior
L’onboarding interactif utilise également
openclaw.install pour les surfaces d’installation à la demande. Si votre Plugin expose des choix d’authentification fournisseur ou des métadonnées de configuration initiale/catalogue de canal avant le chargement du runtime, l’onboarding peut afficher ce choix, demander une installation via ClawHub, npm ou locale, installer ou activer le Plugin, puis poursuivre le flux sélectionné. Les choix d’onboarding ClawHub utilisent clawhubSpec et sont préférés lorsqu’ils sont présents ; les choix npm nécessitent des métadonnées de catalogue approuvées avec un npmSpec de registre ; les versions exactes et expectedIntegrity sont des épinglages npm facultatifs. Si expectedIntegrity est présent, les flux d’installation/mise à jour l’appliquent pour npm. Conservez les métadonnées « quoi afficher » dans openclaw.plugin.json et les métadonnées « comment l’installer » dans package.json.minHostVersion enforcement
minHostVersion enforcement
Si
minHostVersion est défini, l’installation et le chargement non groupé depuis le registre de manifestes l’appliquent tous les deux. Les hôtes plus anciens ignorent les Plugins externes ; les chaînes de version invalides sont rejetées. Les Plugins source groupés sont supposés être co-versionnés avec le checkout de l’hôte.Pinned npm installs
Pinned npm installs
Pour les installations npm épinglées, conservez la version exacte dans
npmSpec et ajoutez l’intégrité attendue de l’artefact :allowInvalidConfigRecovery scope
allowInvalidConfigRecovery scope
allowInvalidConfigRecovery n’est pas un contournement général pour les configurations cassées. Il est réservé à une récupération étroite des Plugins groupés, afin que la réinstallation/configuration initiale puisse réparer des restes de mise à niveau connus, comme un chemin de Plugin groupé manquant ou une entrée channels.<id> obsolète pour ce même Plugin. Si la configuration est cassée pour des raisons sans rapport, l’installation échoue toujours de manière fermée et indique à l’opérateur d’exécuter openclaw doctor --fix.Chargement complet différé
Les Plugins de canal peuvent opter pour le chargement différé avec :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 unopenclaw.plugin.json à la racine du package. OpenClaw l’utilise pour valider la configuration sans exécuter le code du Plugin.
kind et channels :
Publication ClawHub
Pour les packages de plugins, utilisez la commande ClawHub propre au package :L’ancien alias de publication réservé aux Skills concerne les Skills. Les packages de plugins doivent toujours utiliser
clawhub package publish.Point d’entrée de configuration
Le fichiersetup-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).
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.
When OpenClaw uses setupEntry instead of the full entry
When OpenClaw uses setupEntry instead of the full entry
- Le canal est désactivé mais nécessite des surfaces de configuration/intégration.
- Le canal est activé mais non configuré.
- Le chargement différé est activé (
deferConfiguredChannelFullLoadUntilAfterListen).
What setupEntry must register
What setupEntry must register
- L’objet plugin de canal (via
defineSetupPluginEntry). - Toute route HTTP requise avant l’écoute du Gateway.
- Toute méthode Gateway nécessaire pendant le démarrage.
config.* ou update.*.What setupEntry should NOT include
What setupEntry should NOT include
- Les enregistrements CLI.
- Les services d’arrière-plan.
- Les imports d’exécution lourds (chiffrement, SDK).
- Les méthodes Gateway nécessaires uniquement après le démarrage.
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 largeplugin-sdk/setup lorsque vous n’avez besoin que d’une partie de la surface de configuration :
| Chemin d’import | À utiliser pour | Exports clés |
|---|---|---|
plugin-sdk/setup-runtime | assistants d’exécution au moment de la configuration qui restent disponibles dans setupEntry / démarrage différé des canaux | createSetupTranslator, createPatchedAccountSetupAdapter, createEnvPatchedAccountSetupAdapter, createSetupInputPresenceValidator, noteChannelLookupFailure, noteChannelLookupSummary, promptResolvedAllowFrom, splitSetupEntries, createAllowlistSetupWizardProxy, createDelegatedSetupWizardProxy |
plugin-sdk/setup-adapter-runtime | alias de compatibilité obsolète ; utilisez plugin-sdk/setup-runtime | createEnvPatchedAccountSetupAdapter |
plugin-sdk/setup-tools | assistants CLI/archive/docs pour la configuration/l’installation | formatCliCommand, detectBinary, extractArchive, resolveBrewExecutable, formatDocsLink, CONFIG_DIR |
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 promunamedAccountPromotionKeys: 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 canalresolveSingleAccountPromotionTarget(...): choisir quel compte existant reçoit les valeurs promues
Matrix est l’exemple groupé actuel. Si exactement un compte Matrix nommé existe déjà, ou si
defaultAccount pointe vers une clé non canonique existante comme Ops, la promotion préserve ce compte au lieu de créer une nouvelle entrée accounts.default.Schéma de configuration
La configuration du plugin est validée avec le JSON Schema dans votre manifeste. Les utilisateurs configurent les plugins via :api.pluginConfig pendant l’enregistrement.
Pour une configuration propre à un canal, utilisez plutôt la section de configuration du canal :
Construction de schémas de configuration de canal
UtilisezbuildChannelConfigSchema pour convertir un schéma Zod en enveloppe ChannelConfigSchema utilisée par les artefacts de configuration appartenant au plugin :
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 pouropenclaw onboard. L’assistant est un objet ChannelSetupWizard sur le ChannelPlugin :
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.
Standard channel setup status
Standard channel setup status
Pour les blocs d’état de configuration de canal qui ne varient que par les libellés, les scores et les lignes supplémentaires facultatives, préférez
createStandardChannelSetupStatus(...) depuis openclaw/plugin-sdk/setup au lieu de recréer manuellement le même objet status dans chaque plugin.Optional channel setup surface
Optional channel setup surface
Pour les surfaces de configuration facultatives qui ne doivent apparaître que dans certains contextes, utilisez
createOptionalChannelSetupSurface depuis openclaw/plugin-sdk/channel-setup :plugin-sdk/channel-setup expose aussi les constructeurs de plus bas niveau createOptionalChannelSetupAdapter(...) et createOptionalChannelSetupWizard(...) lorsque vous n’avez besoin que d’une moitié de cette surface d’installation facultative.L’adaptateur/l’assistant facultatif généré échoue de manière fermée lors de vraies écritures de configuration. Ils réutilisent un message d’installation requise unique dans validateInput, applyAccountConfig et finalize, et ajoutent un lien vers la documentation lorsque docsPath est défini.Binary-backed setup helpers
Binary-backed setup helpers
Pour les interfaces de configuration adossées à un binaire, préférez les assistants délégués partagés au lieu de copier le même raccordement binaire/état dans chaque canal :
createDetectedBinaryStatus(...)pour les blocs d’état qui ne varient que par les libellés, les indications, les scores et la détection binairecreateCliPathTextInput(...)pour les champs de texte adossés à des cheminscreateDelegatedSetupWizardStatusResolvers(...),createDelegatedPrepare(...),createDelegatedFinalize(...)etcreateDelegatedResolveConfigured(...)lorsquesetupEntrydoit transférer paresseusement vers un assistant complet plus lourdcreateDelegatedTextInputShouldPrompt(...)lorsquesetupEntrydoit uniquement déléguer une décisiontextInputs[*].shouldPrompt
Publication et installation
Plugins externes : publiez sur ClawHub, puis installez :- npm
- ClawHub only
- npm package spec
Pour les installations provenant de npm,
openclaw plugins install installe le paquet dans un projet propre à chaque plugin sous ~/.openclaw/npm/projects, avec les scripts de cycle de vie désactivés. Gardez les arborescences de dépendances des plugins en JS/TS pur et évitez les paquets qui nécessitent des compilations postinstall.Le démarrage du Gateway n’installe pas les dépendances des plugins. Les flux d’installation npm/git/ClawHub sont responsables de la convergence des dépendances ; les dépendances des plugins locaux doivent déjà être installées.
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 —
definePluginEntryetdefineChannelPluginEntry