Skip to main content

Comandos de plugins

Os comandos de plugins são aqueles que o MB CLI monta automaticamente a partir dos plugins instalados. Eles aparecem como mb <categoria> <comando> (e podem ter subcategorias, por exemplo mb infra ci deploy).

O que são

Cada plugin que você instala ou registra vira um ou mais comandos na árvore do CLI. A categoria vem da estrutura de pastas (ou do path do plugin); o comando é o nome definido no manifest.yaml ou o nome da pasta. Assim, você executa o plugin chamando o comando correspondente.

Exemplos:

  • Plugin em tools/hello/mb tools hello
  • Plugin em infra/ci/deploy/mb infra ci deploy

Na folha com entrypoint ou flags, o nome do subcomando no CLI vem do campo command do manifest.yaml (o último segmento do caminho interno continua a ser o nome da pasta). Plugins só com flags (sem entrypoint raiz) precisam de uma flag declarada para correr um script — ex.: mb tools do --deploy.

Em categorias (manifest sem entrypoint nem flags), o campo aliases no manifest.yaml define atalhos para esse segmento (ex.: mb ai sk se skills tiver aliases: [sk]). É preciso mb plugins sync para atualizar o cache após alterar aliases.

Cache: os comandos vêm do SQLite após mb plugins sync. O mb plugins add dispara o sync; se editar ficheiros diretamente em PluginsDir, volte a correr mb plugins sync para atualizar listagem, help e completion. Para detalhes sobre o fluxo de sync e digest de comandos, veja Cache SQLite e sync.

Como descobrir os comandos

  • mb plugins list — Lista todos os plugins instalados, com pacote (identificador da instalação), caminho do comando, descrição, versão, origem (local ou remoto) e URL/path. Use essa saída para saber exatamente quais comandos estão disponíveis.
  • mb help — Mostra a árvore de comandos, incluindo as categorias e comandos de plugins. Comandos de plugins locais aparecem com a indicação "(local)" na descrição.
  • Completion — Depois de mb plugins sync, o completion (TAB) sugere categorias e comandos. Instale no perfil com mb completion install, remova com mb completion uninstall, ou gere o script com mb completion <bash|zsh|fish|powershell> (ver mb completion install --help).

No help (mb help), subcomandos aninhados podem aparecer em COMANDOS ou em secções definidas com groups.yaml / group_id — ver Grupos de help.

Executando um comando de plugin

Basta chamar o comando com os argumentos que o plugin espera:

mb tools hello
mb infra ci deploy --ambiente prod

Com readme no manifest, a folha e também uma categoria (manifest sem entrypoint/flags) podem expor --readme / -r para ver o Markdown no terminal (glow, se instalado):

mb tools meu-comando --readme
mb infra --readme

Para flags globais do CLI, argumentos posicionais no script e flags desconhecidas, veja Execução: flags e argumentos.

Repositório com vários plugins

Um único mb plugins add <url> ou mb plugins add <path> cobre toda a árvore do diretório. Os comandos no CLI seguem a hierarquia de pastas e os manifest.yaml (campo command por nível quando quiser renomear um segmento), sem prefixar pelo identificador do pacote na árvore de comandos. Exemplo: repo com tools/postman e dev/kinfomb tools postman, mb dev kinfo.

A coluna PACOTE em mb plugins list é o identificador da instalação (definido por --package ou nome do diretório), usado em mb plugins remove e mb plugins update. Para regras completas de nomenclatura de pacotes, veja Nome do pacote.

Plugin local vs remoto

Na listagem (mb plugins list), a coluna ORIGEM indica se o plugin é local (instalado por path ou .) ou remoto (instalado por URL Git). No help (mb help ou mb <categoria> <comando> --help), comandos de plugins locais exibem (local) ao lado da descrição, para você saber que aquele comando vem de um plugin registrado localmente.

Para detalhes de como o CLI descobre e executa os plugins (cache, sync, resolução de paths), veja Plugins (referência técnica).