Referentie voor Plugin-verpakking (Documentation Index
Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt
Use this file to discover all available pages before exploring further.
package.json-metadata), manifests (openclaw.plugin.json), setupvermeldingen en configuratieschema’s.
Pakketmetadata
Jepackage.json heeft een openclaw-veld nodig dat het Plugin-systeem vertelt wat je Plugin biedt:
- Kanaal-Plugin
- Provider-Plugin / ClawHub-basislijn
Als je de Plugin extern op ClawHub publiceert, zijn die
compat- en build-velden vereist. De canonieke publicatiesnippets staan in docs/snippets/plugin-publish/.openclaw-velden
Entry point-bestanden (relatief ten opzichte van de pakketroot).
Lichtgewicht vermelding alleen voor setup (optioneel).
Metadata voor de kanaalcatalogus voor setup, kiezer, quickstart en statusoppervlakken.
Provider-id’s die door deze Plugin worden geregistreerd.
Installatiehints:
npmSpec, localPath, defaultChoice, minHostVersion, expectedIntegrity, allowInvalidConfigRecovery.Vlaggen voor opstartgedrag.
openclaw.channel
openclaw.channel is goedkope pakketmetadata voor kanaalontdekking en setupoppervlakken voordat de runtime laadt.
| Veld | Type | Wat het betekent |
|---|---|---|
id | string | Canonieke kanaal-id. |
label | string | Primair kanaallabel. |
selectionLabel | string | Kiezer-/setuplabel wanneer dit moet verschillen van label. |
detailLabel | string | Secundair detaillabel voor rijkere kanaalcatalogi en statusoppervlakken. |
docsPath | string | Documentatiepad voor setup- en selectielinks. |
docsLabel | string | Overschrijft het label dat voor documentatielinks wordt gebruikt wanneer dit moet verschillen van de kanaal-id. |
blurb | string | Korte onboarding-/catalogusbeschrijving. |
order | number | Sorteervolgorde in kanaalcatalogi. |
aliases | string[] | Extra opzoekaliassen voor kanaalselectie. |
preferOver | string[] | Plugin-/kanaal-id’s met lagere prioriteit waar dit kanaal boven moet staan. |
systemImage | string | Optionele pictogram-/systeemafbeeldingsnaam voor kanaal-UI-catalogi. |
selectionDocsPrefix | string | Voorvoegseltekst vóór documentatielinks in selectieoppervlakken. |
selectionDocsOmitLabel | boolean | Toon het documentatiepad direct in plaats van een gelabelde documentatielink in selectietekst. |
selectionExtras | string[] | Extra korte strings die aan selectietekst worden toegevoegd. |
markdownCapable | boolean | Markeert het kanaal als markdown-geschikt voor beslissingen over uitgaande opmaak. |
exposure | object | Zichtbaarheidsinstellingen voor kanalen voor setup, geconfigureerde lijsten en documentatieoppervlakken. |
quickstartAllowFrom | boolean | Laat dit kanaal deelnemen aan de standaard quickstart-setupflow allowFrom. |
forceAccountBinding | boolean | Vereis expliciete accountkoppeling, zelfs wanneer er maar één account bestaat. |
preferSessionLookupForAnnounceTarget | boolean | Geef de voorkeur aan sessieopzoeking bij het oplossen van aankondigingsdoelen voor dit kanaal. |
exposure ondersteunt:
configured: neem het kanaal op in geconfigureerde/statusachtige lijstoppervlakkensetup: neem het kanaal op in interactieve setup-/configureerkiezersdocs: markeer het kanaal als publiek zichtbaar in documentatie-/navigatieoppervlakken
showConfigured en showInSetup blijven ondersteund als legacy-aliassen. Geef de voorkeur aan exposure.openclaw.install
openclaw.install is pakketmetadata, geen manifestmetadata.
| Veld | Type | Wat het betekent |
|---|---|---|
npmSpec | string | Canonieke npm-specificatie voor installatie-/updateflows. |
localPath | string | Lokaal ontwikkelpad of gebundeld installatiepad. |
defaultChoice | "npm" | "local" | Installatiebron met voorkeur wanneer beide beschikbaar zijn. |
minHostVersion | string | Minimaal ondersteunde OpenClaw-versie in de vorm >=x.y.z. |
expectedIntegrity | string | Verwachte npm-dist-integriteitstring, meestal sha512-..., voor gepinde installaties. |
allowInvalidConfigRecovery | boolean | Laat herinstallatieflows voor gebundelde Plugins herstellen van specifieke oude configuratiefouten. |
Onboardinggedrag
Onboardinggedrag
Interactieve onboarding gebruikt ook
openclaw.install voor install-on-demand-oppervlakken. Als je Plugin provider-auth-keuzes of metadata voor kanaalsetup/-catalogus beschikbaar maakt voordat de runtime laadt, kan onboarding die keuze tonen, vragen om npm- of lokale installatie, de Plugin installeren of inschakelen en daarna doorgaan met de geselecteerde flow. Npm-onboardingkeuzes vereisen vertrouwde catalogusmetadata met een register-npmSpec; exacte versies en expectedIntegrity zijn optionele pins. Als expectedIntegrity aanwezig is, dwingen installatie-/updateflows dit af. Bewaar de metadata voor “wat te tonen” in openclaw.plugin.json en de metadata voor “hoe het te installeren” in package.json.Afdwinging van minHostVersion
Afdwinging van minHostVersion
Als
minHostVersion is ingesteld, dwingen zowel installatie als laden van het manifestregister dit af. Oudere hosts slaan de Plugin over; ongeldige versiestrings worden geweigerd.Gepinde npm-installaties
Gepinde npm-installaties
Houd voor gepinde npm-installaties de exacte versie in
npmSpec en voeg de verwachte artefactintegriteit toe:Bereik van allowInvalidConfigRecovery
Bereik van allowInvalidConfigRecovery
allowInvalidConfigRecovery is geen algemene bypass voor kapotte configuraties. Het is alleen bedoeld voor beperkt herstel van gebundelde Plugins, zodat herinstallatie/setup bekende upgrade-restanten kan repareren, zoals een ontbrekend gebundeld Plugin-pad of een oude channels.<id>-vermelding voor diezelfde Plugin. Als de configuratie om niet-gerelateerde redenen kapot is, faalt de installatie nog steeds gesloten en meldt deze de operator dat openclaw doctor --fix moet worden uitgevoerd.Uitgestelde volledige laadactie
Kanaal-Plugins kunnen kiezen voor uitgesteld laden met:setupEntry tijdens de opstartfase vóór luisteren, zelfs voor al geconfigureerde kanalen. De volledige vermelding laadt nadat de Gateway begint te luisteren.
Als je setup-/volledige vermelding Gateway-RPC-methoden registreert, houd ze dan op een Plugin-specifiek voorvoegsel. Gereserveerde core-admin-naamruimten (config.*, exec.approvals.*, wizard.*, update.*) blijven eigendom van core en worden altijd opgelost naar operator.admin.
Plugin-manifest
Elke native Plugin moet eenopenclaw.plugin.json in de pakketroot meeleveren. OpenClaw gebruikt dit om configuratie te valideren zonder Plugin-code uit te voeren.
kind en channels toe:
ClawHub-publicatie
Gebruik voor Plugin-pakketten de pakketspecifieke ClawHub-opdracht:De legacy publicatiealias alleen voor Skills is bedoeld voor Skills. Plugin-pakketten moeten altijd
clawhub package publish gebruiken.Setupvermelding
Het bestandsetup-entry.ts is een lichtgewicht alternatief voor index.ts dat OpenClaw laadt wanneer het alleen setupoppervlakken nodig heeft (onboarding, configuratieherstel, inspectie van uitgeschakelde kanalen).
defineBundledChannelSetupEntry(...) uit openclaw/plugin-sdk/channel-entry-contract gebruiken in plaats van defineSetupPluginEntry(...). Dat gebundelde contract ondersteunt ook een optionele runtime-export, zodat runtimebedrading tijdens setup lichtgewicht en expliciet kan blijven.
Wanneer OpenClaw setupEntry gebruikt in plaats van de volledige entry
Wanneer OpenClaw setupEntry gebruikt in plaats van de volledige entry
- Het kanaal is uitgeschakeld maar heeft setup-/onboardingoppervlakken nodig.
- Het kanaal is ingeschakeld maar niet geconfigureerd.
- Uitgesteld laden is ingeschakeld (
deferConfiguredChannelFullLoadUntilAfterListen).
Wat setupEntry moet registreren
Wat setupEntry moet registreren
- Het kanaalpluginobject (via
defineSetupPluginEntry). - Alle HTTP-routes die vereist zijn voordat de gateway luistert.
- Alle gatewaymethoden die tijdens het opstarten nodig zijn.
config.* of update.* vermijden.Wat setupEntry NIET moet bevatten
Wat setupEntry NIET moet bevatten
- CLI-registraties.
- Achtergrondservices.
- Zware runtime-imports (crypto, SDK’s).
- Gatewaymethoden die pas na het opstarten nodig zijn.
Smalle setup-helperimports
Voor hete paden die alleen setup gebruiken, geef je de voorkeur aan de smalle setup-helpernaden boven de bredereplugin-sdk/setup-paraplu wanneer je slechts een deel van het setupoppervlak nodig hebt:
| Importpad | Gebruik dit voor | Belangrijkste exports |
|---|---|---|
plugin-sdk/setup-runtime | runtimehelpers tijdens setup die beschikbaar blijven in setupEntry / uitgestelde kanaalstart | createPatchedAccountSetupAdapter, createEnvPatchedAccountSetupAdapter, createSetupInputPresenceValidator, noteChannelLookupFailure, noteChannelLookupSummary, promptResolvedAllowFrom, splitSetupEntries, createAllowlistSetupWizardProxy, createDelegatedSetupWizardProxy |
plugin-sdk/setup-adapter-runtime | omgevingsbewuste adapters voor accountsetup | createEnvPatchedAccountSetupAdapter |
plugin-sdk/setup-tools | helpers voor setup-/installatie-CLI/archief/docs | formatCliCommand, detectBinary, extractArchive, resolveBrewExecutable, formatDocsLink, CONFIG_DIR |
plugin-sdk/setup-naad wanneer je de volledige gedeelde setup-toolbox wilt, inclusief config-patchhelpers zoals moveSingleAccountChannelSectionToDefaultAccount(...).
De setup-patchadapters blijven importveilig voor hete paden. Hun gebundelde lookup van het contractoppervlak voor promotie van één account is lui, dus het importeren van plugin-sdk/setup-runtime laadt de ontdekking van gebundelde contractoppervlakken niet gretig voordat de adapter daadwerkelijk wordt gebruikt.
Kanaaleigen promotie van één account
Wanneer een kanaal opwaardeert van een top-level configuratie met één account naarchannels.<id>.accounts.*, is het standaard gedeelde gedrag om gepromoveerde account-scoped waarden naar accounts.default te verplaatsen.
Gebundelde kanalen kunnen die promotie via hun setupcontractoppervlak beperken of overschrijven:
singleAccountKeysToMove: extra top-level sleutels die naar het gepromoveerde account moeten worden verplaatstnamedAccountPromotionKeys: wanneer benoemde accounts al bestaan, worden alleen deze sleutels naar het gepromoveerde account verplaatst; gedeelde beleids-/leveringssleutels blijven op de kanaalrootresolveSingleAccountPromotionTarget(...): kies welk bestaand account gepromoveerde waarden ontvangt
Matrix is het huidige gebundelde voorbeeld. Als er al precies één benoemd Matrix-account bestaat, of als
defaultAccount naar een bestaande niet-canonieke sleutel zoals Ops verwijst, behoudt promotie dat account in plaats van een nieuwe accounts.default-entry te maken.Config-schema
Plugin-configuratie wordt gevalideerd tegen het JSON Schema in je manifest. Gebruikers configureren plugins via:api.pluginConfig tijdens registratie.
Gebruik voor kanaalspecifieke configuratie in plaats daarvan de kanaalconfiguratiesectie:
Kanaalconfiguratieschema’s bouwen
GebruikbuildChannelConfigSchema om een Zod-schema om te zetten naar de ChannelConfigSchema-wrapper die door plugineigen configuratieartefacten wordt gebruikt:
openclaw.plugin.json#channelConfigs, zodat configuratieschema-, setup- en UI-oppervlakken channels.<id> kunnen inspecteren zonder runtimecode te laden.
Setupwizards
Kanaalplugins kunnen interactieve setupwizards leveren vooropenclaw onboard. De wizard is een ChannelSetupWizard-object op de ChannelPlugin:
ChannelSetupWizard ondersteunt credentials, textInputs, dmPolicy, allowFrom, groupAccess, prepare, finalize en meer. Zie gebundelde pluginpakketten (bijvoorbeeld de Discord-plugin src/channel.setup.ts) voor volledige voorbeelden.
Gedeelde allowFrom-prompts
Gedeelde allowFrom-prompts
Voor DM-allowlistprompts die alleen de standaardflow
note -> prompt -> parse -> merge -> patch nodig hebben, geef je de voorkeur aan de gedeelde setuphelpers uit openclaw/plugin-sdk/setup: createPromptParsedAllowFromForAccount(...), createTopLevelChannelParsedAllowFromPrompt(...) en createNestedChannelParsedAllowFromPrompt(...).Standaardstatus voor kanaalsetup
Standaardstatus voor kanaalsetup
Voor statusblokken voor kanaalsetup die alleen variëren op labels, scores en optionele extra regels, geef je de voorkeur aan
createStandardChannelSetupStatus(...) uit openclaw/plugin-sdk/setup in plaats van in elke Plugin hetzelfde status-object handmatig te maken.Optioneel oppervlak voor kanaalsetup
Optioneel oppervlak voor kanaalsetup
Gebruik voor optionele setupoppervlakken die alleen in bepaalde contexten moeten verschijnen
createOptionalChannelSetupSurface uit openclaw/plugin-sdk/channel-setup:plugin-sdk/channel-setup biedt ook de lagere createOptionalChannelSetupAdapter(...)- en createOptionalChannelSetupWizard(...)-builders wanneer je slechts één helft van dat optionele installatieoppervlak nodig hebt.De gegenereerde optionele adapter/wizard faalt gesloten bij echte configuratieschrijfacties. Ze hergebruiken één installatie-verplichtbericht in validateInput, applyAccountConfig en finalize, en voegen een docslink toe wanneer docsPath is ingesteld.Setuphelpers met binaire ondersteuning
Setuphelpers met binaire ondersteuning
Voor setup-UI’s met binaire ondersteuning geef je de voorkeur aan de gedeelde gedelegeerde helpers in plaats van dezelfde binaire/statuslijm naar elk kanaal te kopiëren:
createDetectedBinaryStatus(...)voor statusblokken die alleen variëren op labels, hints, scores en binaire detectiecreateCliPathTextInput(...)voor tekstinvoer met padondersteuningcreateDelegatedSetupWizardStatusResolvers(...),createDelegatedPrepare(...),createDelegatedFinalize(...)encreateDelegatedResolveConfigured(...)wanneersetupEntrylui moet doorsturen naar een zwaardere volledige wizardcreateDelegatedTextInputShouldPrompt(...)wanneersetupEntryalleen eentextInputs[*].shouldPrompt-beslissing hoeft te delegeren
Publiceren en installeren
Externe plugins: publiceer naar ClawHub en installeer daarna:- Automatisch (ClawHub en daarna npm)
- Alleen ClawHub
- npm-pakketspecificatie
Voor installs uit npm voert
openclaw plugins install projectlokale npm install --ignore-scripts uit (geen lifecycle-scripts), waarbij overgenomen globale npm-installatie-instellingen worden genegeerd. Houd afhankelijkheidsbomen van plugins puur JS/TS en vermijd pakketten die postinstall-builds vereisen.Gebundelde plugins die eigendom zijn van OpenClaw zijn de enige uitzondering voor herstel bij het opstarten: wanneer een pakketinstallatie ziet dat er een is ingeschakeld via pluginconfiguratie, verouderde kanaalconfiguratie of het gebundelde manifest dat standaard ingeschakeld is, installeert het opstartproces de ontbrekende runtime-afhankelijkheden van die plugin vóór het importeren. Operators kunnen die fase inspecteren of herstellen met
openclaw plugins deps. Plugins van derden mogen niet vertrouwen op installaties bij het opstarten; blijf de expliciete plugininstaller gebruiken.openclaw.bundle.mirroredRootRuntimeDependencies in het rootpakketmanifest.
Gerelateerd
- Plugins bouwen — stapsgewijze gids om aan de slag te gaan
- Pluginmanifest — volledige referentie voor het manifestschema
- SDK-invoerpunten —
definePluginEntryendefineChannelPluginEntry