Pular para o conteúdo principal

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.

A maioria dos fluxos de trabalho de plugins envolve alguns comandos: pesquisar, instalar, reiniciar o Gateway, verificar e desinstalar quando você não precisar mais do plugin.

Listar plugins

openclaw plugins list
openclaw plugins list --enabled
openclaw plugins list --verbose
openclaw plugins list --json
Use --json em scripts. Ele inclui diagnósticos do registro e o dependencyStatus estático de cada plugin quando o pacote do plugin declara dependencies ou optionalDependencies.
openclaw plugins list --json \
  | jq '.plugins[] | {id, enabled, format, source, dependencyStatus}'
plugins list é uma verificação de inventário a frio. Ele mostra o que o OpenClaw consegue descobrir a partir da configuração, dos manifestos e do registro de plugins; ele não prova que um processo do Gateway já em execução importou o runtime do plugin.

Instalar plugins

# Search ClawHub for plugin packages.
openclaw plugins search "calendar"

# Bare package specs try ClawHub first, then npm fallback.
openclaw plugins install <package>

# Force one source.
openclaw plugins install clawhub:<package>
openclaw plugins install npm:<package>

# Install a specific version or dist-tag.
openclaw plugins install clawhub:<package>@1.2.3
openclaw plugins install clawhub:<package>@beta
openclaw plugins install npm:@scope/openclaw-plugin@1.2.3
openclaw plugins install npm:@openclaw/codex

# Install from git or a local development checkout.
openclaw plugins install git:github.com/acme/openclaw-plugin@v1.0.0
openclaw plugins install ./my-plugin
openclaw plugins install --link ./my-plugin
Depois de instalar o código do plugin, reinicie o Gateway que atende seus canais:
openclaw gateway restart
openclaw plugins inspect <plugin-id> --runtime --json
Use inspect --runtime quando precisar de prova de que o plugin registrou superfícies de runtime como ferramentas, hooks, serviços, métodos do Gateway ou comandos de CLI pertencentes ao plugin.

Atualizar plugins

openclaw plugins update <plugin-id>
openclaw plugins update <npm-package-or-spec>
openclaw plugins update --all
Se um plugin foi instalado a partir de uma dist-tag do npm, como @beta, chamadas posteriores a update <plugin-id> reutilizam essa tag registrada. Passar uma especificação explícita do npm altera a instalação rastreada para essa especificação em atualizações futuras.
openclaw plugins update @scope/openclaw-plugin@beta
openclaw plugins update @scope/openclaw-plugin
O segundo comando move um plugin de volta para a linha de lançamento padrão do registro quando ele estava anteriormente fixado em uma versão exata ou tag. Quando openclaw update é executado no canal beta, registros de plugins npm e ClawHub da linha padrão tentam primeiro o lançamento @beta correspondente do plugin. Se esse lançamento beta não existir, o OpenClaw volta para a especificação padrão/mais recente registrada. Versões exatas e tags explícitas, como @rc ou @beta, são preservadas.

Desinstalar plugins

openclaw plugins uninstall <plugin-id> --dry-run
openclaw plugins uninstall <plugin-id>
openclaw plugins uninstall <plugin-id> --keep-files
openclaw gateway restart
A desinstalação remove a entrada de configuração do plugin, o registro de índice do plugin, entradas de lista de permissão/negação e caminhos de carregamento vinculados quando aplicável. Diretórios de instalação gerenciados são removidos, a menos que você passe --keep-files.

Publicar plugins

Você pode publicar plugins externos no ClawHub, npmjs.com ou ambos.

Publicar no ClawHub

O ClawHub é a principal superfície pública de descoberta para plugins do OpenClaw. Ele oferece aos usuários metadados pesquisáveis, histórico de versões e resultados de varredura do registro antes da instalação.
npm i -g clawhub
clawhub login
clawhub package publish your-org/your-plugin --dry-run
clawhub package publish your-org/your-plugin
clawhub package publish your-org/your-plugin@v1.0.0
Os usuários instalam a partir do ClawHub com:
openclaw plugins install clawhub:<package>
openclaw plugins install <package>
A forma simples ainda verifica o ClawHub primeiro.

Publicar no npmjs.com

Plugins npm nativos devem incluir um manifesto de plugin e metadados de ponto de entrada do OpenClaw no package.json.
package.json
{
  "name": "@acme/openclaw-plugin",
  "version": "1.0.0",
  "type": "module",
  "openclaw": {
    "extensions": ["./dist/index.js"]
  }
}
npm publish --access public
Os usuários instalam apenas pelo npm com:
openclaw plugins install npm:@acme/openclaw-plugin
openclaw plugins install npm:@acme/openclaw-plugin@beta
openclaw plugins install npm:@acme/openclaw-plugin@1.0.0
Se o mesmo pacote também estiver disponível no ClawHub, npm: ignora a consulta ao ClawHub e força a resolução pelo npm.

Escolha da origem

  • ClawHub: use quando quiser descoberta nativa do OpenClaw, resumos de varredura, versões e dicas de instalação.
  • npmjs.com: use quando você já distribui pacotes JavaScript ou precisa de fluxos de trabalho de dist-tags do npm/registro privado.
  • Git: use quando quiser instalar diretamente de uma branch, tag ou commit.
  • Caminho local: use quando estiver desenvolvendo ou testando um plugin na mesma máquina.

Relacionados