Referência para empacotamento de plugins (metadados deDocumentation 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), manifestos (openclaw.plugin.json), entradas de configuração e esquemas de configuração.
Metadados do pacote
Seupackage.json precisa de um campo openclaw que informa ao sistema de plugins o que seu plugin fornece:
- Plugin de canal
- Plugin de provedor / linha de base do ClawHub
Se você publicar o plugin externamente no ClawHub, esses campos
compat e build serão obrigatórios. Os snippets canônicos de publicação ficam em docs/snippets/plugin-publish/.Campos de openclaw
Arquivos de ponto de entrada (relativos à raiz do pacote).
Entrada leve apenas de configuração (opcional).
Metadados do catálogo de canais para superfícies de configuração, seletor, início rápido e status.
IDs de provedores registrados por este plugin.
Dicas de instalação:
npmSpec, localPath, defaultChoice, minHostVersion, expectedIntegrity, allowInvalidConfigRecovery.Flags de comportamento de inicialização.
openclaw.channel
openclaw.channel é metadado barato de pacote para descoberta de canais e superfícies de configuração antes do runtime carregar.
| Campo | Tipo | O que significa |
|---|---|---|
id | string | ID canônico do canal. |
label | string | Rótulo principal do canal. |
selectionLabel | string | Rótulo do seletor/configuração quando deve ser diferente de label. |
detailLabel | string | Rótulo secundário de detalhe para catálogos de canais e superfícies de status mais ricos. |
docsPath | string | Caminho da documentação para links de configuração e seleção. |
docsLabel | string | Rótulo substituto usado para links da documentação quando deve ser diferente do ID do canal. |
blurb | string | Descrição curta de onboarding/catálogo. |
order | number | Ordem de classificação em catálogos de canais. |
aliases | string[] | Aliases extras de busca para seleção de canal. |
preferOver | string[] | IDs de plugin/canal de menor prioridade que este canal deve superar. |
systemImage | string | Nome opcional de ícone/imagem do sistema para catálogos de UI de canais. |
selectionDocsPrefix | string | Texto de prefixo antes dos links da documentação em superfícies de seleção. |
selectionDocsOmitLabel | boolean | Mostra o caminho da documentação diretamente em vez de um link de documentação rotulado no texto de seleção. |
selectionExtras | string[] | Strings curtas extras anexadas ao texto de seleção. |
markdownCapable | boolean | Marca o canal como compatível com markdown para decisões de formatação de saída. |
exposure | object | Controles de visibilidade do canal para configuração, listas configuradas e superfícies de documentação. |
quickstartAllowFrom | boolean | Inclui este canal no fluxo padrão de configuração de início rápido allowFrom. |
forceAccountBinding | boolean | Exige vinculação explícita de conta mesmo quando existe apenas uma conta. |
preferSessionLookupForAnnounceTarget | boolean | Prefere busca de sessão ao resolver alvos de anúncio para este canal. |
exposure é compatível com:
configured: inclui o canal em superfícies de listagem configuradas/de estilo statussetup: inclui o canal em seletores interativos de configuraçãodocs: marca o canal como público em superfícies de documentação/navegação
showConfigured e showInSetup continuam compatíveis como aliases legados. Prefira exposure.openclaw.install
openclaw.install é metadado de pacote, não metadado de manifesto.
| Campo | Tipo | O que significa |
|---|---|---|
clawhubSpec | string | Spec canônica do ClawHub para fluxos de instalação/atualização e instalação sob demanda no onboarding. |
npmSpec | string | Spec canônica do npm para fluxos alternativos de instalação/atualização. |
localPath | string | Caminho de desenvolvimento local ou instalação empacotada. |
defaultChoice | "clawhub" | "npm" | "local" | Origem de instalação preferida quando várias origens estão disponíveis. |
minHostVersion | string | Versão mínima compatível do OpenClaw no formato >=x.y.z ou >=x.y.z-prerelease. |
expectedIntegrity | string | String de integridade esperada do dist do npm, geralmente sha512-..., para instalações fixadas. |
allowInvalidConfigRecovery | boolean | Permite que fluxos de reinstalação de plugins empacotados se recuperem de falhas específicas de configuração obsoleta. |
Comportamento de onboarding
Comportamento de onboarding
O onboarding interativo também usa
openclaw.install para superfícies de instalação sob demanda. Se seu plugin expõe opções de autenticação de provedor ou metadados de configuração/catálogo de canal antes do runtime carregar, o onboarding pode mostrar essa opção, solicitar instalação pelo ClawHub, npm ou local, instalar ou habilitar o plugin e então continuar o fluxo selecionado. As opções de onboarding do ClawHub usam clawhubSpec e são preferidas quando presentes; opções npm exigem metadados de catálogo confiáveis com um npmSpec de registro; versões exatas e expectedIntegrity são pins npm opcionais. Se expectedIntegrity estiver presente, os fluxos de instalação/atualização o aplicam para npm. Mantenha os metadados de “o que mostrar” em openclaw.plugin.json e os metadados de “como instalar” em package.json.Aplicação de minHostVersion
Aplicação de minHostVersion
Se
minHostVersion estiver definido, a instalação e o carregamento do registro de manifestos não empacotados o aplicam. Hosts mais antigos ignoram plugins externos; strings de versão inválidas são rejeitadas. Plugins de origem empacotados são presumidos como tendo a mesma versão do checkout do host.Instalações npm fixadas
Instalações npm fixadas
Para instalações npm fixadas, mantenha a versão exata em
npmSpec e adicione a integridade esperada do artefato:Escopo de allowInvalidConfigRecovery
Escopo de allowInvalidConfigRecovery
allowInvalidConfigRecovery não é uma solução geral para contornar configurações quebradas. Ele existe apenas para recuperação restrita de plugins empacotados, para que reinstalação/configuração possa reparar sobras conhecidas de upgrade, como um caminho ausente de plugin empacotado ou uma entrada channels.<id> obsoleta para esse mesmo plugin. Se a configuração estiver quebrada por motivos não relacionados, a instalação ainda falha de forma fechada e informa ao operador para executar openclaw doctor --fix.Carregamento completo adiado
Plugins de canal podem optar por carregamento adiado com:setupEntry durante a fase de inicialização anterior à escuta, mesmo para canais já configurados. A entrada completa carrega depois que o Gateway começa a escutar.
Se sua entrada de configuração/completa registra métodos RPC do Gateway, mantenha-os em um prefixo específico do plugin. Namespaces administrativos centrais reservados (config.*, exec.approvals.*, wizard.*, update.*) continuam pertencendo ao núcleo e sempre resolvem para operator.admin.
Manifesto de plugin
Todo plugin nativo deve incluir umopenclaw.plugin.json na raiz do pacote. O OpenClaw usa isso para validar a configuração sem executar código do plugin.
kind e channels:
Publicação no ClawHub
Para pacotes de plugin, use o comando ClawHub específico do pacote:O alias legado de publicação apenas para skills é para skills. Pacotes de Plugin devem sempre usar
clawhub package publish.Entrada de configuração
O arquivosetup-entry.ts é uma alternativa leve ao index.ts que o OpenClaw carrega quando precisa apenas de superfícies de configuração (onboarding, reparo de configuração, inspeção de canal desativado).
defineBundledChannelSetupEntry(...) de openclaw/plugin-sdk/channel-entry-contract em vez de defineSetupPluginEntry(...). Esse contrato agrupado também aceita um export opcional runtime, para que a ligação de runtime em tempo de configuração permaneça leve e explícita.
Quando o OpenClaw usa setupEntry em vez da entrada completa
Quando o OpenClaw usa setupEntry em vez da entrada completa
- O canal está desativado, mas precisa de superfícies de configuração/onboarding.
- O canal está ativado, mas não configurado.
- O carregamento adiado está ativado (
deferConfiguredChannelFullLoadUntilAfterListen).
O que setupEntry deve registrar
O que setupEntry deve registrar
- O objeto de Plugin do canal (via
defineSetupPluginEntry). - Quaisquer rotas HTTP necessárias antes do gateway escutar.
- Quaisquer métodos de gateway necessários durante a inicialização.
config.* ou update.*.O que setupEntry NÃO deve incluir
O que setupEntry NÃO deve incluir
- Registros de CLI.
- Serviços em segundo plano.
- Imports pesados de runtime (criptografia, SDKs).
- Métodos de Gateway necessários apenas após a inicialização.
Imports estreitos de auxiliares de configuração
Para caminhos quentes somente de configuração, prefira os pontos de integração estreitos de auxiliares de configuração em vez do guarda-chuva mais amploplugin-sdk/setup quando você precisar apenas de parte da superfície de configuração:
| Caminho de import | Use para | Exports principais |
|---|---|---|
plugin-sdk/setup-runtime | auxiliares de runtime em tempo de configuração que permanecem disponíveis em setupEntry / inicialização adiada de canal | createPatchedAccountSetupAdapter, createEnvPatchedAccountSetupAdapter, createSetupInputPresenceValidator, noteChannelLookupFailure, noteChannelLookupSummary, promptResolvedAllowFrom, splitSetupEntries, createAllowlistSetupWizardProxy, createDelegatedSetupWizardProxy |
plugin-sdk/setup-adapter-runtime | alias de compatibilidade obsoleto; use plugin-sdk/setup-runtime | createEnvPatchedAccountSetupAdapter |
plugin-sdk/setup-tools | auxiliares de CLI/arquivo/docs para configuração/instalação | formatCliCommand, detectBinary, extractArchive, resolveBrewExecutable, formatDocsLink, CONFIG_DIR |
plugin-sdk/setup quando quiser o conjunto completo compartilhado de ferramentas de configuração, incluindo auxiliares de patch de configuração como moveSingleAccountChannelSectionToDefaultAccount(...).
Os adaptadores de patch de configuração continuam seguros para caminhos quentes no import. A busca de superfície de contrato agrupada para promoção de conta única é lazy, portanto importar plugin-sdk/setup-runtime não carrega antecipadamente a descoberta de superfície de contrato agrupada antes que o adaptador seja realmente usado.
Promoção de conta única controlada pelo canal
Quando um canal faz upgrade de uma configuração de nível superior de conta única parachannels.<id>.accounts.*, o comportamento compartilhado padrão é mover valores promovidos com escopo de conta para accounts.default.
Canais agrupados podem restringir ou substituir essa promoção por meio de sua superfície de contrato de configuração:
singleAccountKeysToMove: chaves adicionais de nível superior que devem ser movidas para a conta promovidanamedAccountPromotionKeys: quando contas nomeadas já existem, apenas essas chaves são movidas para a conta promovida; chaves compartilhadas de política/entrega permanecem na raiz do canalresolveSingleAccountPromotionTarget(...): escolher qual conta existente recebe os valores promovidos
Matrix é o exemplo agrupado atual. Se exatamente uma conta Matrix nomeada já existir, ou se
defaultAccount apontar para uma chave não canônica existente, como Ops, a promoção preserva essa conta em vez de criar uma nova entrada accounts.default.Esquema de configuração
A configuração do Plugin é validada contra o JSON Schema no seu manifesto. Usuários configuram plugins via:api.pluginConfig durante o registro.
Para configuração específica de canal, use a seção de configuração do canal em vez disso:
Criando esquemas de configuração de canal
UsebuildChannelConfigSchema para converter um esquema Zod no wrapper ChannelConfigSchema usado por artefatos de configuração controlados pelo Plugin:
openclaw.plugin.json#channelConfigs para que o esquema de configuração, a configuração e as superfícies de UI possam inspecionar channels.<id> sem carregar código de runtime.
Assistentes de configuração
Plugins de canal podem fornecer assistentes interativos de configuração paraopenclaw onboard. O assistente é um objeto ChannelSetupWizard em ChannelPlugin:
ChannelSetupWizard aceita credentials, textInputs, dmPolicy, allowFrom, groupAccess, prepare, finalize e mais. Veja pacotes de Plugin agrupados (por exemplo, o Plugin do Discord src/channel.setup.ts) para exemplos completos.
Prompts allowFrom compartilhados
Prompts allowFrom compartilhados
Para prompts de allowlist de DM que precisam apenas do fluxo padrão
note -> prompt -> parse -> merge -> patch, prefira os auxiliares de configuração compartilhados de openclaw/plugin-sdk/setup: createPromptParsedAllowFromForAccount(...), createTopLevelChannelParsedAllowFromPrompt(...) e createNestedChannelParsedAllowFromPrompt(...).Status padrão de configuração de canal
Status padrão de configuração de canal
Para blocos de status de configuração de canal que variam apenas por labels, pontuações e linhas extras opcionais, prefira
createStandardChannelSetupStatus(...) de openclaw/plugin-sdk/setup em vez de recriar manualmente o mesmo objeto status em cada Plugin.Superfície opcional de configuração de canal
Superfície opcional de configuração de canal
Para superfícies opcionais de configuração que devem aparecer apenas em determinados contextos, use
createOptionalChannelSetupSurface de openclaw/plugin-sdk/channel-setup:plugin-sdk/channel-setup também expõe os builders de nível mais baixo createOptionalChannelSetupAdapter(...) e createOptionalChannelSetupWizard(...) quando você precisa apenas de uma metade dessa superfície opcional de instalação.O adaptador/assistente opcional gerado falha de modo fechado em gravações reais de configuração. Eles reutilizam uma mensagem de instalação obrigatória em validateInput, applyAccountConfig e finalize, e acrescentam um link de docs quando docsPath está definido.Auxiliares de configuração baseados em binário
Auxiliares de configuração baseados em binário
Para UIs de configuração baseadas em binário, prefira os auxiliares delegados compartilhados em vez de copiar a mesma ligação de binário/status para cada canal:
createDetectedBinaryStatus(...)para blocos de status que variam apenas por labels, dicas, pontuações e detecção de bináriocreateCliPathTextInput(...)para entradas de texto baseadas em caminhocreateDelegatedSetupWizardStatusResolvers(...),createDelegatedPrepare(...),createDelegatedFinalize(...)ecreateDelegatedResolveConfigured(...)quandosetupEntryprecisa encaminhar para um assistente completo mais pesado de forma lazycreateDelegatedTextInputShouldPrompt(...)quandosetupEntryprecisa apenas delegar uma decisãotextInputs[*].shouldPrompt
Publicação e instalação
Plugins externos: publique no ClawHub, depois instale:- npm
- Somente ClawHub
- Especificação de pacote npm
Para instalações originadas do npm,
openclaw plugins install instala o pacote em ~/.openclaw/npm com scripts de ciclo de vida desabilitados. Mantenha as árvores de dependências dos plugins em JS/TS puro e evite pacotes que exijam compilações de postinstall.A inicialização do Gateway não instala dependências de plugins. Os fluxos de instalação via npm/git/ClawHub são responsáveis pela convergência de dependências; plugins locais já devem ter suas dependências instaladas.
Relacionados
- Criando plugins — guia passo a passo para começar
- Manifesto do plugin — referência completa do esquema do manifesto
- Pontos de entrada do SDK —
definePluginEntryedefineChannelPluginEntry