Plugin-installatie en configuratie

Referentie voor Plugin-verpakking (package.json-metadata), manifests (openclaw.plugin.json), setupvermeldingen en configuratieschema's.

Pakketmetadata

Je package.json heeft een openclaw-veld nodig dat het Plugin-systeem vertelt wat je plugin biedt:

{  "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",  "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"    }  }}

openclaw-velden

openclaw.channel

openclaw.channel is goedkope pakketmetadata voor kanaalontdekking en setupoppervlakken voordat de runtime laadt.

Voorbeeld:

{  "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 ondersteunt:

• configured: neem het kanaal op in geconfigureerde/statusachtige lijstoppervlakken
• setup: neem het kanaal op in interactieve setup-/configureerpickers
• docs: markeer het kanaal als publiek zichtbaar in documentatie-/navigatieoppervlakken

openclaw.install

openclaw.install is pakketmetadata, geen manifestmetadata.

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

Uitgestelde volledige laadactie

Kanaalplugins kunnen kiezen voor uitgesteld laden met:

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

Wanneer dit is ingeschakeld, laadt OpenClaw tijdens de pre-listen-opstartfase alleen setupEntry, zelfs voor kanalen die al zijn geconfigureerd. De volledige entry laadt nadat de Gateway begint te luisteren.

Als je setup-/volledige entry Gateway-RPC-methoden registreert, houd ze dan op een Plugin-specifieke prefix. Gereserveerde core-adminnamespaces (config.*, exec.approvals.*, wizard.*, update.*) blijven eigendom van core en lossen altijd op naar operator.admin.

Plugin-manifest

Elke native Plugin moet een openclaw.plugin.json in de pakketroot leveren. OpenClaw gebruikt dit om configuratie te valideren zonder Plugin-code uit te voeren.

{  "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"      }    }  }}

Voeg voor kanaalplugins kind en channels toe:

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

Zelfs Plugins zonder configuratie moeten een schema leveren. Een leeg schema is geldig:

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

Zie Plugin-manifest voor de volledige schemareferentie.

Publiceren naar ClawHub

Gebruik voor Plugin-pakketten de pakketspecifieke ClawHub-opdracht:

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

Setup-entry

Het bestand setup-entry.ts is een lichtgewicht alternatief voor index.ts dat OpenClaw laadt wanneer het alleen setup-oppervlakken nodig heeft (onboarding, configuratieherstel, inspectie van uitgeschakelde kanalen).

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

Dit voorkomt dat zware runtimecode (cryptobibliotheken, CLI-registraties, achtergrondservices) wordt geladen tijdens setup-flows.

Gebundelde workspace-kanalen die setup-veilige exports in sidecar-modules bewaren, kunnen defineBundledChannelSetupEntry(...) uit openclaw/plugin-sdk/channel-entry-contract gebruiken in plaats van defineSetupPluginEntry(...). Dat gebundelde contract ondersteunt ook een optionele runtime-export, zodat runtime-bedrading tijdens setup lichtgewicht en expliciet kan blijven.

Smalle imports voor setuphelpers

Geef voor hete paden die alleen setup gebruiken de voorkeur aan de smalle seams voor setuphelpers boven de bredere paraplu plugin-sdk/setup wanneer je slechts een deel van het setup-oppervlak nodig hebt:

Gebruik de bredere seam plugin-sdk/setup wanneer je de volledige gedeelde setup-toolbox wilt, inclusief helpers voor configuratiepatches zoals moveSingleAccountChannelSectionToDefaultAccount(...).

Gebruik createSetupTranslator(...) voor vaste tekst in setupwizards. Deze volgt de locale van de CLI-wizard (OPENCLAW_LOCALE, daarna systeemlocalevariabelen) en valt terug op Engels. Houd Plugin-specifieke setuptekst in code die eigendom is van de Plugin en gebruik gedeelde catalogussleutels alleen voor algemene setuplabels, statustekst en officiële setuptekst voor gebundelde Plugins.

De setup-patchadapters blijven importveilig voor hete paden. Hun gebundelde lookup van het contractoppervlak voor promotie van één account is lazy, dus het importeren van plugin-sdk/setup-runtime laadt de discovery van gebundelde contractoppervlakken niet eager voordat de adapter daadwerkelijk wordt gebruikt.

Kanaaleigen promotie van één account

Wanneer een kanaal upgradet van een top-level configuratie met één account naar channels.<id>.accounts.*, is het standaard gedeelde gedrag dat gepromoveerde account-scoped waarden naar accounts.default worden verplaatst.

Gebundelde kanalen kunnen die promotie versmallen of overschrijven via hun setup-contractoppervlak:

• singleAccountKeysToMove: extra top-level sleutels die naar het gepromoveerde account moeten worden verplaatst
• namedAccountPromotionKeys: wanneer named accounts al bestaan, worden alleen deze sleutels naar het gepromoveerde account verplaatst; gedeelde beleids-/delivery-sleutels blijven op de kanaalroot
• resolveSingleAccountPromotionTarget(...): kies welk bestaand account gepromoveerde waarden ontvangt

Configuratieschema

Plugin-configuratie wordt gevalideerd tegen het JSON Schema in je manifest. Gebruikers configureren Plugins via:

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

Je Plugin ontvangt deze configuratie als api.pluginConfig tijdens registratie.

Gebruik voor kanaalspecifieke configuratie in plaats daarvan de kanaalconfiguratiesectie:

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

Kanaalconfiguratieschema's bouwen

Gebruik buildChannelConfigSchema om een Zod-schema om te zetten naar de ChannelConfigSchema-wrapper die wordt gebruikt door configuratie-artefacten die eigendom zijn van Plugins:

  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);

Als je het contract al als JSON Schema of TypeBox schrijft, gebruik dan de directe helper zodat OpenClaw Zod-naar-JSON-Schema-conversie op metadatapaden kan overslaan:

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

Voor Plugins van derden blijft het cold-path-contract het Plugin-manifest: spiegel het gegenereerde JSON Schema naar openclaw.plugin.json#channelConfigs, zodat configuratieschema-, setup- en UI-oppervlakken channels.<id> kunnen inspecteren zonder runtimecode te laden.

Setupwizards

Kanaal-Plugins kunnen interactieve setupwizards leveren voor openclaw onboard. De wizard is een ChannelSetupWizard-object op de 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),        };      },    },  ],};

Het type ChannelSetupWizard ondersteunt credentials, textInputs, dmPolicy, allowFrom, groupAccess, prepare, finalize en meer. Zie gebundelde Plugin-pakketten (bijvoorbeeld de Discord-Plugin src/channel.setup.ts) voor volledige voorbeelden.

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 }

Publiceren en installeren

Externe plugins: publiceer naar ClawHub en installeer daarna:

openclaw plugins install @myorg/openclaw-my-plugin

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

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

Plugins in de repo: plaats ze onder de gebundelde plugin-werkruimteboom en ze worden automatisch ontdekt tijdens de build.

Gebruikers kunnen installeren:

openclaw plugins install <package-name>

Gebundelde pakketmetadata is expliciet en wordt niet afgeleid uit gebouwde JavaScript bij het opstarten van de Gateway. Runtime-afhankelijkheden horen thuis in het plugin-pakket dat ze bezit; het opstarten van verpakte OpenClaw repareert of spiegelt plugin-afhankelijkheden nooit.

Gerelateerd

• Plugins bouwen — stapsgewijze handleiding om aan de slag te gaan
• Plugin-manifest — volledige schemareferentie voor het manifest
• SDK-toegangspunten — definePluginEntry en defineChannelPluginEntry