Comandos

A CLI do bdot é a interface central para gerenciamento do ciclo de vida, estado, usuários e recursos da plataforma local. Esta página detalha a sintaxe, flags e comportamento de cada comando disponível.

Estrutura Geral de Execução

bdot [comando] [flags]

Flags Globais

As flags globais podem ser utilizadas com qualquer comando da CLI:

Flag	Abreviação	Descrição
`--config`	—	Especifica um caminho customizado para o arquivo `.env` (Padrão: `~/.bdot/.env`).
`--local`	`-l`	Utiliza o diretório atual como workspace em vez de `~/.bdot/` (Modo Desenvolvedor).
`--verbose`	`-v`	Habilita a saída detalhada para diagnóstico e depuração.

Ciclo de Vida da Plataforma

`bdot setup`

Gerencia o assistente de configuração e provisiona as variáveis do .env e segredos do ambiente.

bdot setup [flags]

Flags Específicas

--fast-config: Executa a configuração rápida de forma não-interativa utilizando os valores padrão do sistema.

Exemplo

# Modo interativo (TUI)
bdot setup

# Modo não-interativo para automação / CI
bdot setup --fast-config

`bdot up`

Inicia a execução de todos os containers da plataforma com um dashboard interativo em tempo real.

bdot up [flags]

O que o comando faz automaticamente:

Validação: Verifica a existência do .env (exige bdot setup prévio) e checa pré-requisitos do sistema (Docker Engine, arquitetura e RAM).
Segurança e TLS: Garante a existência das credenciais em .bdot_secrets/, gera os certificados TLS autoassinados (bdot.crt/bdot.key) em ~/.bdot/certs/ e cria as configurações estáticas e dinâmicas do Traefik.
mDNS: Anuncia o hostname na rede local via ZeroConf/mDNS para resolução via .local.
Healthcheck: Monitora a subida e aguarda o estado saudável (healthy) do banco de dados (bdot-database) e do SSO (bdot-sso).
Ajuste de SSO: Garante automaticamente que as rotas HTTP e HTTPS do client bdot-web estejam autorizadas no Keycloak.

Flags Específicas

--silent, -s: Modo silencioso (headless), oculta a interface gráfica TUI (ideal para scripts).

Exemplo

bdot up

`bdot down`

Interrompe e remove todos os containers e redes criados pela plataforma (docker compose down --remove-orphans).

bdot down [flags]

Flags Específicas

--silent, -s: Desativa a TUI e executa a parada de forma silenciosa.

Exemplo

bdot down

Monitoramento e Diagnóstico

`bdot status`

Exibe um dashboard interativo em tempo real do estado de cada serviço e exibe o card de URLs de acesso à plataforma assim que todos os componentes estiverem operacionais.

bdot status

Atalhos no terminal: Pressione r para recarregar o status manualmente ou q para sair.

`bdot ps`

Exibe uma lista simplificada em formato de tabela do estado atual dos containers mantidos pelo projeto Docker Compose.

bdot ps

`bdot version`

Exibe as informações detalhadas de versão do binário do bdot CLI, incluindo a tag da aplicação, hash do commit Git e data de compilação.

bdot version

Gestão de Recursos e Infraestrutura

`bdot volumes`

Interface de gerenciamento de volumes de dados persistes associados ao projeto Docker.

bdot volumes

Operações Disponíveis na TUI:

[d] Deletar: Remove o volume selecionado após confirmação do usuário.
[b] Backup: Cria uma cópia de segurança compactada dos dados do volume selecionado para um caminho informado no terminal.
[q] Sair: Fecha a interface de gerenciamento.

`bdot add-user`

Cria ou redefine usuários (pessoas) no provedor de identidade (SSO/Keycloak) com a flag de troca obrigatória de senha no primeiro acesso (UPDATE_PASSWORD).

bdot add-user [flags]

Flags Específicas

--user, -u: Nome de usuário/identificador no SSO.
--email, -e: E-mail associado à conta.
--generate-new, -g: Gera uma senha forte automaticamente (utilizado para execuções não-interativas).
--sso-url: Sobrescreve a URL base do servidor SSO (padrão: derivada de BDOT_CFG_HOSTNAME).

Exemplos

# Modo interativo (solicita dados no terminal)
bdot add-user

# Modo não-interativo com geração automática de senha
bdot add-user --user dev.silva --email dev@empresa.com --generate-new

`bdot update-hostname`

Registra o hostname configurado no daemon do Avahi/mDNS no Linux e atualiza o arquivo /etc/hosts para garantir a resolução do domínio local na rede (.local).

sudo bdot update-hostname --hostname [NOME] --port [PORTA]

Flags Obrigatórias

--hostname: O nome de domínio local a ser registrado (ex: bdot.local).
--port: Porta do serviço HTTP/HTTPS a ser publicada no mDNS.

Exemplo

sudo bdot update-hostname --hostname bdot.local --port 81

Resumo Rápido de Comandos

Comando	Descrição	Requer Terminal Interativo?
`bdot setup`	Assistente de configuração e variáveis (`.env`)	Não (se usar `--fast-config`)
`bdot up`	Inicia todos os microsserviços e proxy Traefik	Não (se usar `--silent`)
`bdot down`	Para e remove a infraestrutura local	Não (se usar `--silent`)
`bdot status`	Exibe o painel de status dos containers em tempo real	Sim
`bdot ps`	Lista os containers em formato de tabela simples	Não
`bdot volumes`	Gerencia (lista, deleta e faz backup) de volumes Docker	Sim
`bdot add-user`	Adiciona ou altera credenciais de usuários no Keycloak	Não (se usar `-u`, `-e` e `-g`)
`bdot update-hostname`	Configura registros de rede Avahi/mDNS no Linux (`sudo`)	Não
`bdot version`	Exibe os dados de build e versão da CLI	Não