---
read_when:
- Vous ajoutez un assistant de configuration à un Plugin
- Vous devez comprendre setup-entry.ts par rapport à index.ts
- Vous définissez des schémas de configuration de plugin ou des métadonnées openclaw dans package.json
sidebarTitle: Setup and config
summary: Assistants de configuration, setup-entry.ts, schémas de configuration et métadonnées de package.json
title: Installation et configuration du Plugin
x-i18n:
generated_at: "2026-05-11T20:49:57Z"
model: gpt-5.5
provider: openai
source_hash: 7e6c59d7201cc1402cd648a37fc498fbb7e4043a661dcd39c2e62fcf01067879
source_path: plugins/sdk-setup.md
workflow: 16
---
Référence pour l’empaquetage des plugins (métadonnées `package.json`), les manifestes (`openclaw.plugin.json`), les entrées de configuration et les schémas de configuration.
**Vous cherchez un guide pas à pas ?** Les guides pratiques couvrent l’empaquetage en contexte : [Plugins de canal](/fr/plugins/sdk-channel-plugins#step-1-package-and-manifest) et [Plugins de fournisseur](/fr/plugins/sdk-provider-plugins#step-1-package-and-manifest).
## Métadonnées du package
Votre `package.json` doit contenir un champ `openclaw` qui indique au système de plugins ce que fournit votre plugin :
```json
{
"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."
}
}
}
```
```json openclaw-clawhub-package.json
{
"name": "@myorg/openclaw-my-plugin",
"version": "1.0.0",
"type": "module",
"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"
}
}
}
```
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 (facultatif).
Métadonnées du catalogue de canaux pour les surfaces de configuration, de sélection, de démarrage rapide et d’état.
ID 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` est une métadonnée de package légère pour la découverte des canaux et les surfaces de configuration avant le chargement de l’exécution.
| Champ | Type | Signification |
| -------------------------------------- | ---------- | ----------------------------------------------------------------------------- |
| `id` | `string` | ID canonique du canal. |
| `label` | `string` | Libellé principal du canal. |
| `selectionLabel` | `string` | Libellé du sélecteur/de la configuration lorsqu’il doit différer de `label`. |
| `detailLabel` | `string` | Libellé de détail secondaire pour les catalogues de canaux et les surfaces d’état plus riches. |
| `docsPath` | `string` | Chemin de documentation pour les liens de configuration et de sélection. |
| `docsLabel` | `string` | Libellé de remplacement utilisé pour les liens de documentation lorsqu’il doit différer de l’ID du canal. |
| `blurb` | `string` | Courte description d’intégration/de catalogue. |
| `order` | `number` | Ordre de tri dans les catalogues de canaux. |
| `aliases` | `string[]` | Alias de recherche supplémentaires pour la sélection de canal. |
| `preferOver` | `string[]` | ID de plugins/canaux de priorité inférieure que ce canal doit devancer. |
| `systemImage` | `string` | Nom facultatif d’icône/d’image système pour les catalogues d’interface de canal. |
| `selectionDocsPrefix` | `string` | Texte de préfixe avant les liens de documentation dans les surfaces de sélection. |
| `selectionDocsOmitLabel` | `boolean` | Afficher 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 avec Markdown pour les décisions de mise en forme sortante. |
| `exposure` | `object` | Contrôles de visibilité du canal pour la configuration, les listes configurées et les surfaces de documentation. |
| `quickstartAllowFrom` | `boolean` | Inclure ce canal dans le flux de configuration standard de démarrage rapide `allowFrom`. |
| `forceAccountBinding` | `boolean` | Exiger une liaison explicite du compte même lorsqu’un seul compte existe. |
| `preferSessionLookupForAnnounceTarget` | `boolean` | Préférer la recherche de session lors de la résolution des cibles d’annonce pour ce canal. |
Exemple :
```json
{
"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 type liste configurée/état
- `setup` : inclure le canal dans les sélecteurs interactifs de configuration
- `docs` : marquer le canal comme public dans les surfaces de documentation/navigation
`showConfigured` et `showInSetup` restent pris en charge en tant qu’alias hérités. Préférez `exposure`.
### `openclaw.install`
`openclaw.install` est une métadonnée de package, pas une métadonnée 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’intégration. |
| `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 certaines défaillances de configuration obsolète. |
L’intégration interactive utilise également `openclaw.install` pour les surfaces d’installation à la demande. Si votre plugin expose des choix d’authentification de fournisseur ou des métadonnées de configuration/catalogue de canal avant le chargement de l’exécution, l’intégration 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’intégration ClawHub utilisent `clawhubSpec` et sont préférés lorsqu’ils sont présents ; les choix npm exigent des métadonnées de catalogue fiables 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`.
Si `minHostVersion` est défini, l’installation et le chargement du registre de manifestes non groupé l’appliquent tous 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 dans la même version que l’extraction de l’hôte.
Pour les installations npm épinglées, conservez la version exacte dans `npmSpec` et ajoutez l’intégrité attendue de l’artefact :
```json
{
"openclaw": {
"install": {
"npmSpec": "@wecom/wecom-openclaw-plugin@1.2.3",
"expectedIntegrity": "sha512-REPLACE_WITH_NPM_DIST_INTEGRITY",
"defaultChoice": "npm"
}
}
}
```
`allowInvalidConfigRecovery` n’est pas un contournement général pour les configurations défectueuses. Il est réservé à la récupération étroite de plugins groupés, afin que la réinstallation/configuration puisse réparer des restes de mise à niveau connus, comme un chemin de plugin groupé manquant ou une entrée `channels.` obsolète pour ce même plugin. Si la configuration est rompue pour des raisons non liées, 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 :
```json
{
"openclaw": {
"extensions": ["./index.ts"],
"setupEntry": "./setup-entry.ts",
"startup": {
"deferConfiguredChannelFullLoadUntilAfterListen": true
}
}
}
```
Lorsqu’il est activé, OpenClaw ne charge que `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.
N’activez le chargement différé que lorsque votre `setupEntry` enregistre tout ce dont le gateway a besoin avant de commencer à écouter (enregistrement du canal, routes HTTP, méthodes du gateway). Si l’entrée complète possède des capacités de démarrage requises, conservez le comportement par défaut.
Si votre entrée de configuration/complète enregistre des méthodes RPC de gateway, conservez-les sous un préfixe propre au plugin. Les espaces de noms d’administration réservés du cœur (`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.
```json
{
"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` :
```json
{
"id": "my-channel",
"kind": "channel",
"channels": ["my-channel"],
"configSchema": {
"type": "object",
"additionalProperties": false,
"properties": {}
}
}
```
Même les plugins sans configuration doivent fournir un schéma. Un schéma vide est valide :
```json
{
"id": "my-plugin",
"configSchema": {
"type": "object",
"additionalProperties": false
}
}
```
Consultez [Manifeste de plugin](/fr/plugins/manifest) pour la référence complète du schéma.
## Publication ClawHub
Pour les packages de plugins, utilisez la commande ClawHub propre au package :
```bash
clawhub package publish your-org/your-plugin --dry-run
clawhub package publish your-org/your-plugin
```
L’ancien alias de publication réservé aux skills est destiné aux skills. Les paquets Plugin doivent toujours utiliser `clawhub package publish`.
## 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 initiale, réparation de configuration, inspection des canaux désactivés).
```typescript
// setup-entry.ts
import { defineSetupPluginEntry } from "openclaw/plugin-sdk/channel-core";
import { myChannelPlugin } from "./src/channel.js";
export default defineSetupPluginEntry(myChannelPlugin);
```
Cela évite de charger du code d’exécution lourd (bibliothèques de cryptographie, enregistrements CLI, services d’arrière-plan) pendant les flux de configuration.
Les canaux de l’espace de travail intégré qui conservent des exports compatibles avec la configuration dans des modules sidecar peuvent utiliser `defineBundledChannelSetupEntry(...)` depuis `openclaw/plugin-sdk/channel-entry-contract` au lieu de `defineSetupPluginEntry(...)`. Ce contrat intégré 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.
- Le canal est désactivé mais nécessite des surfaces de configuration/intégration initiale.
- Le canal est activé mais non configuré.
- Le chargement différé est activé (`deferConfiguredChannelFullLoadUntilAfterListen`).
- L’objet Plugin de canal (via `defineSetupPluginEntry`).
- Toutes les routes HTTP requises avant l’écoute du Gateway.
- Toutes les méthodes du Gateway nécessaires au démarrage.
Ces méthodes du Gateway au démarrage doivent toujours éviter les espaces de noms d’administration réservés au cœur, tels que `config.*` ou `update.*`.
- Les enregistrements CLI.
- Les services d’arrière-plan.
- Les imports d’exécution lourds (cryptographie, SDK).
- Les méthodes du Gateway nécessaires uniquement après le démarrage.
### Imports étroits des assistants de configuration
Pour les chemins actifs uniquement liés à la configuration, préférez les coutures étroites d’assistants de configuration à l’interface plus large `plugin-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é du canal | `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 configuration/installation | `formatCliCommand`, `detectBinary`, `extractArchive`, `resolveBrewExecutable`, `formatDocsLink`, `CONFIG_DIR` |
Utilisez la couture plus large `plugin-sdk/setup` lorsque vous voulez toute la boîte à outils de configuration partagée, y compris les assistants de correctif de configuration tels que `moveSingleAccountChannelSectionToDefaultAccount(...)`.
Les adaptateurs de correctif de configuration restent sûrs à importer sur les chemins actifs. Leur recherche de surface de contrat intégrée pour la promotion de compte unique est paresseuse, donc l’import de `plugin-sdk/setup-runtime` ne charge pas immédiatement la découverte de surface de contrat intégrée avant l’utilisation réelle de l’adaptateur.
### Promotion de compte unique détenue par le canal
Lorsqu’un canal passe d’une configuration de premier niveau à compte unique à `channels..accounts.*`, le comportement partagé par défaut consiste à déplacer les valeurs promues propres au compte dans `accounts.default`.
Les canaux intégré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 partagées de politique/livraison restent à la racine du canal
- `resolveSingleAccountPromotionTarget(...)` : choisir quel compte existant reçoit les valeurs promues
Matrix est l’exemple intégré actuel. S’il existe déjà exactement un compte Matrix nommé, ou si `defaultAccount` pointe vers une clé non canonique existante telle que `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 par rapport au JSON Schema de votre manifeste. Les utilisateurs configurent les plugins via :
```json5
{
plugins: {
entries: {
"my-plugin": {
config: {
webhookSecret: "abc123",
},
},
},
},
}
```
Votre Plugin reçoit cette configuration sous forme de `api.pluginConfig` pendant l’enregistrement.
Pour une configuration propre à un canal, utilisez plutôt la section de configuration du canal :
```json5
{
channels: {
"my-channel": {
token: "bot-token",
allowFrom: ["user1", "user2"],
},
},
}
```
### Créer des schémas de configuration de canal
Utilisez `buildChannelConfigSchema` pour convertir un schéma Zod dans l’enveloppe `ChannelConfigSchema` utilisée par les artefacts de configuration détenus par le Plugin :
```typescript
import { z } from "zod";
import { buildChannelConfigSchema } from "openclaw/plugin-sdk/channel-config-schema";
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 éviter la conversion Zod vers JSON Schema sur les chemins de métadonnées :
```typescript
import { Type } from "typebox";
import { buildJsonChannelConfigSchema } from "openclaw/plugin-sdk/channel-config-schema";
const configSchema = buildJsonChannelConfigSchema(
Type.Object({
token: Type.Optional(Type.String()),
allowFrom: Type.Optional(Type.Array(Type.String())),
}),
);
```
Pour les plugins tiers, le contrat de chemin froid reste le manifeste du Plugin : reflétez le JSON Schema généré dans `openclaw.plugin.json#channelConfigs` afin que le schéma de configuration, la configuration et les surfaces UI puissent inspecter `channels.` 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` :
```typescript
import type { ChannelSetupWizard } from "openclaw/plugin-sdk/channel-setup";
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 paquets de Plugins intégrés (par exemple le Plugin Discord `src/channel.setup.ts`) pour des exemples complets.
Pour les invites de liste d’autorisation DM qui n’ont besoin que du flux standard `note -> prompt -> parse -> merge -> patch`, préférez les assistants de configuration partagés de `openclaw/plugin-sdk/setup` : `createPromptParsedAllowFromForAccount(...)`, `createTopLevelChannelParsedAllowFromPrompt(...)` et `createNestedChannelParsedAllowFromPrompt(...)`.
Pour les blocs d’état de configuration de canal qui ne varient que par les libellés, scores et 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.
Pour les surfaces de configuration facultatives qui ne doivent apparaître que dans certains contextes, utilisez `createOptionalChannelSetupSurface` depuis `openclaw/plugin-sdk/channel-setup` :
```typescript
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 }
```
`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 et l’assistant facultatifs générés échouent de façon fermée lors de véritables écritures de configuration. Ils réutilisent un même message d’installation requise dans `validateInput`, `applyAccountConfig` et `finalize`, et ajoutent un lien vers la documentation lorsque `docsPath` est défini.
Pour les UI de configuration adossées à un binaire, préférez les assistants délégués partagés au lieu de copier la même colle binaire/état dans chaque canal :
- `createDetectedBinaryStatus(...)` pour les blocs d’état qui ne varient que par les libellés, indices, scores et la détection du binaire
- `createCliPathTextInput(...)` pour les champs texte adossés à un chemin
- `createDelegatedSetupWizardStatusResolvers(...)`, `createDelegatedPrepare(...)`, `createDelegatedFinalize(...)` et `createDelegatedResolveConfigured(...)` lorsque `setupEntry` doit transmettre paresseusement à un assistant complet plus lourd
- `createDelegatedTextInputShouldPrompt(...)` lorsque `setupEntry` doit seulement déléguer une décision `textInputs[*].shouldPrompt`
## Publication et installation
**Plugins externes :** publiez sur [ClawHub](/fr/clawhub), puis installez :
```bash
openclaw plugins install @myorg/openclaw-my-plugin
```
Les spécifications de paquet nues s’installent depuis npm pendant la transition de lancement.
```bash
openclaw plugins install clawhub:@myorg/openclaw-my-plugin
```
Utilisez npm lorsqu’un paquet n’a pas encore été déplacé vers ClawHub, ou lorsque vous avez besoin d’un
chemin d’installation npm direct pendant la migration :
```bash
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 groupés, et ils sont automatiquement découverts pendant la compilation.
**Les utilisateurs peuvent installer :**
```bash
openclaw plugins install
```
Pour les installations provenant de npm, `openclaw plugins install` installe le package sous `~/.openclaw/npm` avec les scripts de cycle de vie désactivés. Gardez les arbres de dépendances des Plugins en JS/TS pur et évitez les packages 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 gèrent la convergence des dépendances ; les Plugins locaux doivent déjà avoir leurs dépendances installées.
Les métadonnées des packages groupés sont explicites, et non déduites du JavaScript compilé au démarrage du gateway. Les dépendances d’exécution appartiennent au package du Plugin qui les possède ; le démarrage d’OpenClaw packagé ne répare ni ne met jamais en miroir les dépendances des Plugins.
## Associés
- [Créer des Plugins](/fr/plugins/building-plugins) — guide de démarrage étape par étape
- [Manifeste de Plugin](/fr/plugins/manifest) — référence complète du schéma de manifeste
- [Points d’entrée du SDK](/fr/plugins/sdk-entrypoints) — `definePluginEntry` et `defineChannelPluginEntry`