Vai al contenuto principale
Riferimento per il packaging dei Plugin (metadati package.json), i manifest (openclaw.plugin.json), le voci di setup e gli schemi di configurazione.
Cerchi una guida passo passo? Le guide pratiche trattano il packaging nel contesto: Plugin di canale e Plugin di provider.

Metadati del pacchetto

Il tuo package.json richiede un campo openclaw che indica al sistema di Plugin cosa fornisce il tuo 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."
    }
  }
}
Se pubblichi il Plugin esternamente su ClawHub, quei campi compat e build sono obbligatori. Gli snippet di pubblicazione canonici si trovano in docs/snippets/plugin-publish/.

Campi openclaw

extensions
string[]
File dei punti di ingresso (relativi alla radice del pacchetto).
setupEntry
string
Voce leggera solo per il setup (facoltativa).
channel
object
Metadati del catalogo dei canali per setup, selettore, quickstart e superfici di stato.
providers
string[]
ID dei provider registrati da questo Plugin.
install
object
Suggerimenti di installazione: npmSpec, localPath, defaultChoice, minHostVersion, expectedIntegrity, allowInvalidConfigRecovery.
startup
object
Flag del comportamento di avvio.

openclaw.channel

openclaw.channel è un metadato di pacchetto leggero per il rilevamento dei canali e le superfici di setup prima del caricamento del runtime.
CampoTipoCosa significa
idstringID canonico del canale.
labelstringEtichetta principale del canale.
selectionLabelstringEtichetta del selettore/setup quando deve differire da label.
detailLabelstringEtichetta di dettaglio secondaria per cataloghi di canali e superfici di stato più ricchi.
docsPathstringPercorso della documentazione per link di setup e selezione.
docsLabelstringEtichetta alternativa usata per i link alla documentazione quando deve differire dall’ID del canale.
blurbstringBreve descrizione per onboarding/catalogo.
ordernumberOrdine di ordinamento nei cataloghi dei canali.
aliasesstring[]Alias di ricerca aggiuntivi per la selezione del canale.
preferOverstring[]ID di Plugin/canale con priorità inferiore che questo canale dovrebbe superare.
systemImagestringNome facoltativo di icona/immagine di sistema per i cataloghi UI dei canali.
selectionDocsPrefixstringTesto prefisso prima dei link alla documentazione nelle superfici di selezione.
selectionDocsOmitLabelbooleanMostra direttamente il percorso della documentazione invece di un link etichettato alla documentazione nel testo di selezione.
selectionExtrasstring[]Stringhe brevi aggiuntive accodate nel testo di selezione.
markdownCapablebooleanContrassegna il canale come compatibile con markdown per le decisioni di formattazione in uscita.
exposureobjectControlli di visibilità del canale per setup, elenchi configurati e superfici della documentazione.
quickstartAllowFrombooleanAbilita questo canale al flusso di setup standard quickstart allowFrom.
forceAccountBindingbooleanRichiede l’associazione esplicita dell’account anche quando esiste un solo account.
preferSessionLookupForAnnounceTargetbooleanPreferisce la ricerca della sessione quando risolve i target di annuncio per questo canale.
Esempio:
{
  "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 supporta:
  • configured: include il canale nelle superfici di elenco configurate/in stile stato
  • setup: include il canale nei selettori interattivi di setup/configurazione
  • docs: contrassegna il canale come pubblico nelle superfici di documentazione/navigazione
showConfigured e showInSetup restano supportati come alias legacy. Preferisci exposure.

openclaw.install

openclaw.install è un metadato di pacchetto, non un metadato di manifest.
CampoTipoCosa significa
clawhubSpecstringSpec ClawHub canonica per flussi di installazione/aggiornamento e onboarding con installazione su richiesta.
npmSpecstringSpec npm canonica per flussi di fallback di installazione/aggiornamento.
localPathstringPercorso di sviluppo locale o installazione in bundle.
defaultChoice"clawhub" | "npm" | "local"Origine di installazione preferita quando sono disponibili più origini.
minHostVersionstringVersione minima supportata di OpenClaw nella forma >=x.y.z o >=x.y.z-prerelease.
expectedIntegritystringStringa di integrità npm dist prevista, di solito sha512-..., per installazioni bloccate.
allowInvalidConfigRecoverybooleanConsente ai flussi di reinstallazione dei Plugin in bundle di recuperare da specifici errori di configurazione obsoleta.
requiredPlatformPackagesstring[]Alias npm specifici della piattaforma richiesti e verificati durante l’installazione npm.
L’onboarding interattivo usa anche openclaw.install per le superfici di installazione su richiesta. Se il tuo Plugin espone scelte di autenticazione del provider o metadati di setup/catalogo del canale prima del caricamento del runtime, l’onboarding può mostrare quella scelta, chiedere l’installazione da ClawHub, npm o locale, installare o abilitare il Plugin, quindi continuare il flusso selezionato. Le scelte di onboarding ClawHub usano clawhubSpec e sono preferite quando presenti; le scelte npm richiedono metadati di catalogo attendibili con un npmSpec di registro; versioni esatte ed expectedIntegrity sono pin npm facoltativi. Se expectedIntegrity è presente, i flussi di installazione/aggiornamento lo applicano per npm. Mantieni i metadati “cosa mostrare” in openclaw.plugin.json e i metadati “come installarlo” in package.json.
Se minHostVersion è impostato, sia l’installazione sia il caricamento del registro dei manifest non in bundle lo applicano. Gli host meno recenti saltano i Plugin esterni; le stringhe di versione non valide vengono rifiutate. Si presume che i Plugin sorgente in bundle abbiano la stessa versione del checkout dell’host.
Per le installazioni npm bloccate, mantieni la versione esatta in npmSpec e aggiungi l’integrità prevista dell’artefatto:
{
  "openclaw": {
    "install": {
      "npmSpec": "@wecom/wecom-openclaw-plugin@1.2.3",
      "expectedIntegrity": "sha512-REPLACE_WITH_NPM_DIST_INTEGRITY",
      "defaultChoice": "npm"
    }
  }
}
allowInvalidConfigRecovery non è un bypass generale per configurazioni non valide. Serve solo per il recupero ristretto dei Plugin in bundle, così reinstallazione/setup possono riparare residui noti di aggiornamento, come un percorso mancante di Plugin in bundle o una voce channels.<id> obsoleta per quello stesso Plugin. Se la configurazione è non valida per motivi non correlati, l’installazione continua a fallire in modo chiuso e indica all’operatore di eseguire openclaw doctor --fix.

Caricamento completo differito

I Plugin di canale possono abilitare il caricamento differito con:
{
  "openclaw": {
    "extensions": ["./index.ts"],
    "setupEntry": "./setup-entry.ts",
    "startup": {
      "deferConfiguredChannelFullLoadUntilAfterListen": true
    }
  }
}
Quando è abilitato, OpenClaw carica solo setupEntry durante la fase di avvio pre-listen, anche per i canali già configurati. La voce completa viene caricata dopo che il gateway inizia ad ascoltare.
Abilita il caricamento differito solo quando il tuo setupEntry registra tutto ciò di cui il gateway ha bisogno prima che inizi ad ascoltare (registrazione del canale, route HTTP, metodi del gateway). Se la voce completa possiede capacità di avvio richieste, mantieni il comportamento predefinito.
Se la tua voce di setup/completa registra metodi RPC del gateway, mantienili su un prefisso specifico del Plugin. Gli spazi dei nomi di amministrazione core riservati (config.*, exec.approvals.*, wizard.*, update.*) restano di proprietà del core e si risolvono sempre in operator.admin.

Manifest del Plugin

Ogni Plugin nativo deve distribuire un openclaw.plugin.json nella radice del pacchetto. OpenClaw lo usa per validare la configurazione senza eseguire codice del 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"
      }
    }
  }
}
Per i Plugin di canale, aggiungi kind e channels:
{
  "id": "my-channel",
  "kind": "channel",
  "channels": ["my-channel"],
  "configSchema": {
    "type": "object",
    "additionalProperties": false,
    "properties": {}
  }
}
Anche i Plugin senza configurazione devono distribuire uno schema. Uno schema vuoto è valido:
{
  "id": "my-plugin",
  "configSchema": {
    "type": "object",
    "additionalProperties": false
  }
}
Consulta manifest del Plugin per il riferimento completo dello schema.

Pubblicazione su ClawHub

Per i pacchetti Plugin, usa il comando ClawHub specifico per pacchetto:
clawhub package publish your-org/your-plugin --dry-run
clawhub package publish your-org/your-plugin
L’alias di pubblicazione legacy riservato alle skill è per le Skills. I pacchetti Plugin devono sempre usare clawhub package publish.

Voce di setup

Il file setup-entry.ts è un’alternativa leggera a index.ts che OpenClaw carica quando servono solo le superfici di setup (onboarding, riparazione della configurazione, ispezione dei canali disabilitati).
// setup-entry.ts
import { defineSetupPluginEntry } from "openclaw/plugin-sdk/channel-core";
import { myChannelPlugin } from "./src/channel.js";

export default defineSetupPluginEntry(myChannelPlugin);
Questo evita di caricare codice runtime pesante (librerie crittografiche, registrazioni CLI, servizi in background) durante i flussi di setup. I canali workspace inclusi che mantengono esportazioni sicure per il setup in moduli sidecar possono usare defineBundledChannelSetupEntry(...) da openclaw/plugin-sdk/channel-entry-contract invece di defineSetupPluginEntry(...). Quel contratto incluso supporta anche un’esportazione opzionale runtime, così il cablaggio runtime in fase di setup può restare leggero ed esplicito.
  • Il canale è disabilitato ma necessita delle superfici di setup/onboarding.
  • Il canale è abilitato ma non configurato.
  • Il caricamento differito è abilitato (deferConfiguredChannelFullLoadUntilAfterListen).
  • L’oggetto Plugin del canale (tramite defineSetupPluginEntry).
  • Qualsiasi rotta HTTP richiesta prima dell’ascolto del gateway.
  • Qualsiasi metodo Gateway necessario durante l’avvio.
Quei metodi Gateway di avvio devono comunque evitare namespace admin core riservati come config.* o update.*.
  • Registrazioni CLI.
  • Servizi in background.
  • Import runtime pesanti (crittografia, SDK).
  • Metodi Gateway necessari solo dopo l’avvio.

Import ristretti degli helper di setup

Per percorsi caldi solo di setup, preferisci i punti di integrazione ristretti degli helper di setup rispetto all’ombrello più ampio plugin-sdk/setup quando ti serve solo una parte della superficie di setup:
Percorso di importazioneUsalo perEsportazioni chiave
plugin-sdk/setup-runtimehelper runtime in fase di setup che restano disponibili in setupEntry / avvio differito del canalecreateSetupTranslator, createPatchedAccountSetupAdapter, createEnvPatchedAccountSetupAdapter, createSetupInputPresenceValidator, noteChannelLookupFailure, noteChannelLookupSummary, promptResolvedAllowFrom, splitSetupEntries, createAllowlistSetupWizardProxy, createDelegatedSetupWizardProxy
plugin-sdk/setup-adapter-runtimealias di compatibilità deprecato; usa plugin-sdk/setup-runtimecreateEnvPatchedAccountSetupAdapter
plugin-sdk/setup-toolshelper per setup/installazione CLI/archivi/documentazioneformatCliCommand, detectBinary, extractArchive, resolveBrewExecutable, formatDocsLink, CONFIG_DIR
Usa il punto di integrazione più ampio plugin-sdk/setup quando vuoi l’intero toolbox di setup condiviso, inclusi helper di patch della configurazione come moveSingleAccountChannelSectionToDefaultAccount(...). Usa createSetupTranslator(...) per il testo fisso della procedura guidata di setup. Segue la lingua della procedura guidata CLI (OPENCLAW_LOCALE, poi le variabili di locale di sistema) e ripiega sull’inglese. Mantieni il testo di setup specifico del Plugin nel codice di proprietà del Plugin e usa chiavi di catalogo condivise solo per etichette di setup comuni, testo di stato e testo di setup dei Plugin ufficiali inclusi. Gli adattatori di patch del setup restano sicuri da importare nei percorsi caldi. La loro ricerca della superficie del contratto di promozione single-account inclusa è lazy, quindi importare plugin-sdk/setup-runtime non carica anticipatamente la discovery delle superfici di contratto incluse prima che l’adattatore venga effettivamente usato.

Promozione single-account di proprietà del canale

Quando un canale passa da una configurazione di primo livello con account singolo a channels.<id>.accounts.*, il comportamento condiviso predefinito consiste nello spostare i valori promossi con ambito account in accounts.default. I canali in bundle possono restringere o sovrascrivere tale promozione tramite la superficie del loro contratto di configurazione:
  • singleAccountKeysToMove: chiavi aggiuntive di primo livello che devono essere spostate nell’account promosso
  • namedAccountPromotionKeys: quando esistono già account denominati, solo queste chiavi vengono spostate nell’account promosso; le chiavi condivise di criterio/consegna restano nella radice del canale
  • resolveSingleAccountPromotionTarget(...): sceglie quale account esistente riceve i valori promossi
Matrix è l’esempio attuale in bundle. Se esiste già esattamente un account Matrix denominato, oppure se defaultAccount punta a una chiave non canonica esistente come Ops, la promozione conserva quell’account invece di creare una nuova voce accounts.default.

Schema di configurazione

La configurazione del Plugin viene validata rispetto al JSON Schema nel manifest. Gli utenti configurano i plugin tramite:
{
  plugins: {
    entries: {
      "my-plugin": {
        config: {
          webhookSecret: "abc123",
        },
      },
    },
  },
}
Il tuo plugin riceve questa configurazione come api.pluginConfig durante la registrazione. Per la configurazione specifica del canale, usa invece la sezione di configurazione del canale:
{
  channels: {
    "my-channel": {
      token: "bot-token",
      allowFrom: ["user1", "user2"],
    },
  },
}

Creazione degli schemi di configurazione dei canali

Usa buildChannelConfigSchema per convertire uno schema Zod nel wrapper ChannelConfigSchema usato dagli artefatti di configurazione di proprietà del plugin:
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);
Se scrivi già il contratto come JSON Schema o TypeBox, usa l’helper diretto così OpenClaw può evitare la conversione da Zod a JSON Schema nei percorsi dei metadati:
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())),
  }),
);
Per i plugin di terze parti, il contratto nel percorso a freddo resta il manifest del plugin: rispecchia il JSON Schema generato in openclaw.plugin.json#channelConfigs così lo schema di configurazione, la configurazione guidata e le superfici dell’interfaccia utente possono ispezionare channels.<id> senza caricare codice runtime.

Configurazioni guidate

I plugin di canale possono fornire configurazioni guidate interattive per openclaw onboard. La procedura guidata è un oggetto ChannelSetupWizard su ChannelPlugin:
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),
        };
      },
    },
  ],
};
Il tipo ChannelSetupWizard supporta credentials, textInputs, dmPolicy, allowFrom, groupAccess, prepare, finalize e altro. Consulta i pacchetti dei plugin in bundle (per esempio il plugin Discord src/channel.setup.ts) per esempi completi.
Per i prompt allowlist dei DM che richiedono solo il flusso standard note -> prompt -> parse -> merge -> patch, preferisci gli helper di configurazione condivisi da openclaw/plugin-sdk/setup: createPromptParsedAllowFromForAccount(...), createTopLevelChannelParsedAllowFromPrompt(...) e createNestedChannelParsedAllowFromPrompt(...).
Per i blocchi di stato della configurazione del canale che variano solo per etichette, punteggi e righe aggiuntive opzionali, preferisci createStandardChannelSetupStatus(...) da openclaw/plugin-sdk/setup invece di costruire manualmente lo stesso oggetto status in ogni plugin.
Per le superfici di configurazione opzionali che devono apparire solo in determinati contesti, usa createOptionalChannelSetupSurface da openclaw/plugin-sdk/channel-setup:
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 espone anche i builder di livello inferiore createOptionalChannelSetupAdapter(...) e createOptionalChannelSetupWizard(...) quando ti serve solo una metà di quella superficie di installazione opzionale.L’adapter/procedura guidata opzionale generato fallisce in modo chiuso sulle scritture di configurazione reali. Riutilizza un unico messaggio di installazione richiesta tra validateInput, applyAccountConfig e finalize, e aggiunge un link alla documentazione quando docsPath è impostato.
Per le interfacce di configurazione basate su binario, preferisci gli helper delegati condivisi invece di copiare la stessa logica di collegamento binario/stato in ogni canale:
  • createDetectedBinaryStatus(...) per blocchi di stato che variano solo per etichette, suggerimenti, punteggi e rilevamento binario
  • createCliPathTextInput(...) per input di testo basati su percorso
  • createDelegatedSetupWizardStatusResolvers(...), createDelegatedPrepare(...), createDelegatedFinalize(...) e createDelegatedResolveConfigured(...) quando setupEntry deve inoltrare a una procedura guidata completa più pesante su richiesta
  • createDelegatedTextInputShouldPrompt(...) quando setupEntry deve solo delegare una decisione textInputs[*].shouldPrompt

Pubblicazione e installazione

Plugin esterni: pubblica su ClawHub, poi installa:
openclaw plugins install @myorg/openclaw-my-plugin
Le specifiche di pacchetto non prefissate vengono installate da npm durante il passaggio di lancio.
Plugin nel repository: inseriscili sotto l’albero dell’area di lavoro dei Plugin inclusi e verranno rilevati automaticamente durante la build. Gli utenti possono installare:
openclaw plugins install <package-name>
Per le installazioni provenienti da npm, openclaw plugins install installa il pacchetto in un progetto per Plugin sotto ~/.openclaw/npm/projects con gli script del ciclo di vita disabilitati. Mantieni gli alberi delle dipendenze dei Plugin in JS/TS puro ed evita pacchetti che richiedono build postinstall.
L’avvio del Gateway non installa le dipendenze dei Plugin. I flussi di installazione npm/git/ClawHub gestiscono la convergenza delle dipendenze; i Plugin locali devono avere già installato le proprie dipendenze.
I metadati dei pacchetti inclusi sono espliciti, non dedotti dal JavaScript compilato all’avvio del Gateway. Le dipendenze di runtime appartengono al pacchetto Plugin che le possiede; l’avvio di OpenClaw pacchettizzato non ripara né replica mai le dipendenze dei Plugin.

Correlati