Flags globais
O MB CLI oferece algumas flags que valem para qualquer comando e afetam o nível de saída e o ambiente. -v e -q podem ser usados em qualquer posição: antes ou depois do subcomando (por exemplo mb -v tools hello ou mb tools hello -v). Em ambos os casos o plugin recebe MB_VERBOSE/MB_QUIET conforme a flag.
Verbose e Quiet
--verbose / -v
O que faz: Ativa saída mais verbosa. O CLI pode exibir mensagens adicionais de diagnóstico ou logs que ajudam a entender o que está acontecendo.
Quando usar: Para depurar um problema, acompanhar o fluxo de um comando ou quando você quer mais detalhes na saída.
Ao executar um comando de plugin, o CLI define no ambiente do processo do plugin a variável MB_VERBOSE=1. O plugin pode usá-la para exibir mais logs (por exemplo, nível debug).
Exemplo:
mb -v plugins list
mb --verbose plugins sync
mb -v tools meu-comando
--quiet / -q
O que faz: Reduz ou suprime mensagens informativas. O CLI evita imprimir avisos ou mensagens de progresso que não sejam estritamente necessárias.
Quando usar: Em scripts ou quando você quer apenas o resultado (por exemplo, saída de um plugin) sem mensagens extras do próprio CLI.
Ao executar um comando de plugin, o CLI define no ambiente do processo do plugin a variável MB_QUIET=1. O plugin pode usá-la para suprimir logs informativos e exibir apenas o essencial (ou apenas erros).
Exemplo:
mb -q plugins list
mb --quiet plugins sync
mb -q update --only-cli --check-only # só código de saída (ex.: 2 = há atualização); sem texto legível em stdout (com `--json`, a linha JSON ainda vai para stdout)
mb -q tools meu-comando
Uso em plugins de shell
Em plugins escritos em shell, você pode ler MB_VERBOSE e MB_QUIET para decidir se imprime mensagens e em qual nível. Assim o plugin respeita a preferência do usuário ao usar -v ou -q.
O CLI disponibiliza helpers de shell (por exemplo a função log) e define no ambiente do plugin a variável MB_HELPERS_PATH (diretório lib/shell no diretório de configuração, ex.: ~/.config/mb/lib/shell no Linux). Os arquivos nesse diretório são criados e atualizados ao rodar mb plugins sync. Para usá-los nos plugins, no início do script faça: . "$MB_HELPERS_PATH/all.sh" (todos) ou . "$MB_HELPERS_PATH/log.sh" (só log). Depois você pode chamar log info "mensagem", log debug "detalhe", etc. Veja a Referência: Helpers de shell para a lista de helpers e como carregar.
MB_QUIET=1— O usuário pediu saída mínima. Evite chamargum logpara mensagens informativas; só mostre erros se fizer sentido.MB_VERBOSE=1— O usuário pediu mais detalhes. Você pode incluir logs em nível debug ou mensagens de diagnóstico.
Para a função log e outros helpers, veja a Referência: Helpers de shell.
--env-file e --env / -e
--env-file <path>— Define um arquivo de variáveis de ambiente (formato.env) que será carregado e mesclado ao ambiente antes de executar um plugin. Útil para manter configurações em um arquivo separado.--env KEY=VALUE— Injeta uma variável no processo do plugin. Pode ser repetido várias vezes. Tem a maior precedência em relação aos outros meios de definir variáveis.
Para a ordem completa de precedência e como usar defaults com mb envs, veja Variáveis de ambiente.
--env-vault
O que faz: Ao executar plugins, depois de carregar env.defaults, mescla por cima o arquivo .env.<nome> no diretório de configuração (valores do vault sobrescrevem chaves iguais do default).
Quando usar: Para alternar entre ambientes (ex.: staging, prod) sem trocar o conteúdo de env.defaults.
mb --env-vault staging tools deploy
O nome do vault segue as mesmas regras que em mb envs set --vault. Detalhes em Variáveis de ambiente.
--help / -h
O que faz: Exibe a ajuda do comando atual, incluindo descrição, sintaxe, flags disponíveis e subcomandos.
Uso: A flag -h / --help está disponível em todos os comandos e subcomandos, incluindo os gerados dinamicamente a partir de plugins instalados.
mb --help # ajuda geral (igual a mb)
mb envs --help # ajuda do subcomando envs
mb plugins add --help # ajuda do subcomando add
mb plugins add -h # mesmo efeito com a forma curta
Equivalência com mb help
O mesmo efeito pode ser obtido com o comando mb help:
| Forma | Resultado |
|---|---|
mb help <cmd> | Ajuda formatada do comando |
mb <cmd> --help | Ajuda inline do comando |
mb <cmd> -h | Ajuda inline do comando (forma curta) |
Para comandos aninhados:
mb help plugins add # ajuda do subcomando add
mb plugins add --help # mesmo resultado
Nota: Para
mb run, prefiramb help runem vez demb run --help, pois o--helppode ser repassado ao programa filho.
Para mais detalhes sobre o comando mb help, veja mb help.
--doc
O que faz: Abre no navegador a URL de documentação configurada (por omissão o site público do projeto). O URL base define-se em config.yaml no diretório de configuração do MB com a chave docs_url. Encerra o CLI com código 0.
Uso: Só no comando raiz, antes de qualquer subcomando — por exemplo mb --doc. Não é herdada por mb plugins list etc.
Detalhes e exemplos: Configuração do CLI (config.yaml).
mb --doc
--version / -V
O que faz: Exibe a versão atual do MB CLI e termina. Se compilado a partir do código sem versão embutida (ldflags), mostra dev.
mb -V
mb --version