package.json), manifests (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:
- Channel plugin
- Provider plugin / ClawHub baseline
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 somente para configuração (opcional).
Metadados de catálogo de canal para configuração, seletor, guia rápido e superfícies de status.
IDs de provedor registrados por este Plugin.
Dicas de instalação:
npmSpec, localPath, defaultChoice, minHostVersion, expectedIntegrity, allowInvalidConfigRecovery.Flags de comportamento de inicialização.
openclaw.channel
openclaw.channel são metadados leves de pacote para descoberta de canal e superfícies de configuração antes que o tempo de execução seja carregado.
| 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 diferir de label. |
detailLabel | string | Rótulo secundário de detalhe para catálogos de canal e superfícies de status mais ricas. |
docsPath | string | Caminho da documentação para links de configuração e seleção. |
docsLabel | string | Substitui o rótulo usado em links de documentação quando deve diferir do ID do canal. |
blurb | string | Descrição curta de integração inicial/catálogo. |
order | number | Ordem de classificação em catálogos de canal. |
aliases | string[] | Aliases extras de consulta para seleção de canal. |
preferOver | string[] | IDs de Plugin/canal de prioridade menor que este canal deve superar. |
systemImage | string | Nome opcional de ícone/imagem do sistema para catálogos de interface de canal. |
selectionDocsPrefix | string | Texto de prefixo antes de links da documentação em superfícies de seleção. |
selectionDocsOmitLabel | boolean | Mostra diretamente o caminho da documentação 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 allowFrom do guia rápido. |
forceAccountBinding | boolean | Exige vinculação explícita de conta mesmo quando existe apenas uma conta. |
preferSessionLookupForAnnounceTarget | boolean | Prefere consulta de sessão ao resolver destinos de anúncio para este canal. |
exposure aceita:
configured: inclui o canal em superfícies de listagem configuradas/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 sendo compatíveis como aliases legados. Prefira exposure.openclaw.install
openclaw.install são metadados de pacote, não metadados de manifest.
| Campo | Tipo | O que significa |
|---|---|---|
clawhubSpec | string | Especificação canônica do ClawHub para fluxos de instalação/atualização e instalação sob demanda na integração inicial. |
npmSpec | string | Especificação npm canônica para fluxos de fallback de instalação/atualização. |
localPath | string | Caminho de desenvolvimento local ou instalação empacotada. |
defaultChoice | "clawhub" | "npm" | "local" | Fonte de instalação preferida quando várias fontes 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 npm, geralmente sha512-..., para instalações fixadas. |
allowInvalidConfigRecovery | boolean | Permite que fluxos de reinstalação de Plugins empacotados recuperem falhas específicas de configuração obsoleta. |
requiredPlatformPackages | string[] | Aliases npm específicos da plataforma obrigatórios verificados durante a instalação npm. |
Onboarding behavior
Onboarding behavior
A integração inicial interativa 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 que o tempo de execução carregue, a integração inicial pode mostrar essa opção, solicitar instalação via ClawHub, npm ou local, instalar ou habilitar o Plugin e então continuar o fluxo selecionado. As opções de integração inicial 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 impõem para npm. Mantenha os metadados de “o que mostrar” em openclaw.plugin.json e os metadados de “como instalar” em package.json.minHostVersion enforcement
minHostVersion enforcement
Se
minHostVersion estiver definido, tanto a instalação quanto o carregamento de registro de manifests não empacotados o impõem. Hosts mais antigos ignoram Plugins externos; strings de versão inválidas são rejeitadas. Presume-se que Plugins de código-fonte empacotados sejam coversionados com o checkout do host.Pinned npm installs
Pinned npm installs
Para instalações npm fixadas, mantenha a versão exata em
npmSpec e adicione a integridade esperada do artefato:allowInvalidConfigRecovery scope
allowInvalidConfigRecovery scope
allowInvalidConfigRecovery não é um bypass geral para configurações quebradas. Ele serve apenas para recuperação estreita de Plugins empacotados, para que reinstalação/configuração possa reparar sobras conhecidas de atualização, como um caminho ausente de Plugin empacotado ou uma entrada obsoleta channels.<id> para esse mesmo Plugin. Se a configuração estiver quebrada por motivos não relacionados, a instalação ainda falhará fechada e instruirá o operador a executar openclaw doctor --fix.Carregamento completo adiado
Plugins de canal podem optar por carregamento adiado com:setupEntry durante a fase de inicialização antes de escutar, 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 reservados de administração do core (config.*, exec.approvals.*, wizard.*, update.*) permanecem de propriedade do core e sempre resolvem para operator.admin.
Manifest do 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 do ClawHub específico do pacote:O alias legado de publicação somente de skill é para skills. Pacotes de Plugin devem sempre usar
clawhub package publish.Entrada de setup
O arquivosetup-entry.ts é uma alternativa leve ao index.ts que o OpenClaw carrega quando precisa apenas de superfícies de setup (onboarding, reparo de configuração, inspeção de canal desabilitado).
defineBundledChannelSetupEntry(...) de openclaw/plugin-sdk/channel-entry-contract em vez de defineSetupPluginEntry(...). Esse contrato agrupado também oferece suporte a um export opcional runtime, para que a fiação de runtime em tempo de setup 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á desabilitado, mas precisa de superfícies de setup/onboarding.
- O canal está habilitado, mas não configurado.
- O carregamento adiado está habilitado (
deferConfiguredChannelFullLoadUntilAfterListen).
O que setupEntry deve registrar
O que setupEntry deve registrar
- O objeto do plugin de 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 somente após a inicialização.
Imports estreitos de helpers de setup
Para caminhos quentes somente de setup, prefira as interfaces estreitas de helpers de setup em vez do guarda-chuva mais amploplugin-sdk/setup quando você só precisar de parte da superfície de setup:
| Caminho de import | Use para | Exports principais |
|---|---|---|
plugin-sdk/setup-runtime | helpers de runtime em tempo de setup que continuam disponíveis em setupEntry / inicialização adiada de canal | createSetupTranslator, 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 | helpers de CLI/arquivamento/docs para setup/instalação | formatCliCommand, detectBinary, extractArchive, resolveBrewExecutable, formatDocsLink, CONFIG_DIR |
plugin-sdk/setup quando quiser a caixa de ferramentas compartilhada completa de setup, incluindo helpers de patch de configuração como moveSingleAccountChannelSectionToDefaultAccount(...).
Use createSetupTranslator(...) para textos fixos do assistente de setup. Ele segue o
locale do assistente da CLI (OPENCLAW_LOCALE, depois variáveis de locale do sistema) e recua
para inglês. Mantenha texto de setup específico do plugin no código pertencente ao plugin e use
chaves de catálogo compartilhadas apenas para rótulos comuns de setup, texto de status e textos de setup de
plugins agrupados oficiais.
Os adaptadores de patch de setup permanecem seguros para caminho quente no import. A consulta de superfície de contrato de promoção de conta única agrupada deles é preguiçosa, então importar plugin-sdk/setup-runtime não carrega avidamente a descoberta de superfície de contrato agrupada antes de o adaptador ser realmente usado.
Promoção de conta única pertencente ao 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 sobrescrever essa promoção por meio da superfície de contrato de setup deles:
singleAccountKeysToMove: chaves extras de nível superior que devem ser movidas para a conta promovidanamedAccountPromotionKeys: quando contas nomeadas já existem, somente estas chaves se movem para a conta promovida; chaves compartilhadas de política/entrega permanecem na raiz do canalresolveSingleAccountPromotionTarget(...): escolhe 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.Schema 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:
Criando schemas de configuração de canal
UsebuildChannelConfigSchema para converter um schema Zod no wrapper ChannelConfigSchema usado por artefatos de configuração pertencentes ao plugin:
openclaw.plugin.json#channelConfigs para que schema de configuração, setup e superfícies de UI possam inspecionar channels.<id> sem carregar código de runtime.
Assistentes de setup
Plugins de canal podem fornecer assistentes interativos de setup paraopenclaw onboard. O assistente é um objeto ChannelSetupWizard no ChannelPlugin:
ChannelSetupWizard oferece suporte a credentials, textInputs, dmPolicy, allowFrom, groupAccess, prepare, finalize e mais. Consulte pacotes de plugins agrupados (por exemplo, o plugin Discord src/channel.setup.ts) para exemplos completos.
Prompts allowFrom compartilhados
Prompts allowFrom compartilhados
Para prompts de lista de permissões de DM que só precisam do fluxo padrão
note -> prompt -> parse -> merge -> patch, prefira os helpers de setup compartilhados de openclaw/plugin-sdk/setup: createPromptParsedAllowFromForAccount(...), createTopLevelChannelParsedAllowFromPrompt(...) e createNestedChannelParsedAllowFromPrompt(...).Status padrão de setup de canal
Status padrão de setup de canal
Para blocos de status de setup de canal que variam apenas por rótulos, pontuações e linhas extras opcionais, prefira
createStandardChannelSetupStatus(...) de openclaw/plugin-sdk/setup em vez de criar manualmente o mesmo objeto status em cada plugin.Superfície opcional de setup de canal
Superfície opcional de setup de canal
Para superfícies opcionais de setup que só devem aparecer em certos contextos, use
createOptionalChannelSetupSurface de openclaw/plugin-sdk/channel-setup:plugin-sdk/channel-setup também expõe os construtores de nível mais baixo createOptionalChannelSetupAdapter(...) e createOptionalChannelSetupWizard(...) quando você precisa apenas de uma metade dessa superfície de instalação opcional.O adaptador/assistente opcional gerado falha fechado em gravações reais de configuração. Eles reutilizam uma mensagem única de instalação necessária em validateInput, applyAccountConfig e finalize, e acrescentam um link de docs quando docsPath está definido.Helpers de setup baseados em binário
Helpers de setup baseados em binário
Para UIs de setup baseadas em binário, prefira os helpers delegados compartilhados em vez de copiar a mesma cola de binário/status para cada canal:
createDetectedBinaryStatus(...)para blocos de status que variam apenas por rótulos, dicas, pontuações e detecção bináriacreateCliPathTextInput(...)para entradas de texto baseadas em caminhocreateDelegatedSetupWizardStatusResolvers(...),createDelegatedPrepare(...),createDelegatedFinalize(...)ecreateDelegatedResolveConfigured(...)quandosetupEntryprecisa encaminhar para um assistente completo mais pesado de forma preguiçosacreateDelegatedTextInputShouldPrompt(...)quandosetupEntrysó precisa delegar uma decisão detextInputs[*].shouldPrompt
Publicação e instalação
Plugins externos: publique no ClawHub e depois instale:- npm
- Somente ClawHub
- Especificação de pacote npm
Para instalações originadas do npm,
openclaw plugins install instala o pacote em um projeto por plugin sob ~/.openclaw/npm/projects com scripts de ciclo de vida desabilitados. Mantenha as árvores de dependências de plugins puramente JS/TS e evite pacotes que exigem builds 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á precisam 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