CLI Reference
Referência completa dos comandos da CLI do Brasa. A CLI utiliza Thor e pode ser instalada via gem install brasa.
brasa login
Autentica o usuário na plataforma Brasa. Armazena o token de acesso localmente em ~/.brasa/credentials.
Uso
$ brasa login
Opções
| Flag | Descrição |
|---|---|
--token TOKEN | Autentica usando um API token (sem prompt interativo) |
Exemplo
$ brasa login Email: dev@empresa.com.br Senha: ******** Autenticado com sucesso! Token salvo em ~/.brasa/credentials
brasa init
Inicializa uma aplicação no diretório atual. Detecta automaticamente o stack (Rails, Node.js, etc.) e cria o arquivo de configuração brasa.yml.
Uso
$ brasa init [--name NOME] [--region REGIÃO]
Opções
| Flag | Descrição |
|---|---|
--name NOME | Nome do app (inferido do diretório se omitido) |
--region REGIÃO | Região do deploy (padrão: br-south-1) |
Exemplo
$ brasa init --name meu-saas Detectado: Ruby on Rails 8.0 Região: br-south-1 (São Paulo) Arquivo brasa.yml criado. App "meu-saas" registrado com sucesso!
brasa up
Executa o deploy da aplicação. Empacota o código, envia para a Magalu Cloud, constrói a imagem e inicia os containers.
Uso
$ brasa up [--branch BRANCH]
Opções
| Flag | Descrição |
|---|---|
--branch BRANCH | Branch do Git a ser deployado (padrão: branch atual) |
--skip-build | Pula a etapa de build (usa imagem existente) |
Exemplo
$ brasa up Empacotando aplicação... OK Enviando para Magalu Cloud... OK (12.3 MB) Construindo imagem... OK (45s) Iniciando containers... OK Deploy #42 concluído! URL: https://meu-saas.usebrasa.com.br
brasa status
Exibe o status atual da aplicação, incluindo instâncias em execução e informações do último deploy.
Uso
$ brasa status
Exemplo
$ brasa status App: meu-saas Status: running Stack: Ruby on Rails 8.0 Region: br-south-1 Instâncias: web.1 running healthy 256MB web.2 running healthy 256MB URL: https://meu-saas.usebrasa.com.br Último deploy: #42 (há 3 horas)
brasa logs
Visualiza os logs da aplicação. Use a flag --tail para acompanhar em tempo real.
Uso
$ brasa logs [--tail] [--lines N]
Opções
| Flag | Descrição |
|---|---|
--tail | Acompanha logs em tempo real (streaming) |
--lines N | Número de linhas a exibir (padrão: 100) |
Exemplo
$ brasa logs --tail --lines 50 2025-01-15T10:30:00 web.1 | Started GET "/" for 200 2025-01-15T10:30:01 web.1 | Completed 200 OK in 45ms 2025-01-15T10:30:05 web.2 | Started POST "/api/v1/apps" for 201
brasa env set
Define uma variável de ambiente para a aplicação. O app é reiniciado automaticamente após a alteração.
Uso
$ brasa env set KEY=VALUE [KEY2=VALUE2 ...]
Exemplo
$ brasa env set DATABASE_URL=postgres://user:pass@host/db RAILS_ENV=production Variáveis definidas: DATABASE_URL = postgres://user:****@host/db RAILS_ENV = production Reiniciando app... OK
brasa env list
Lista todas as variáveis de ambiente configuradas para a aplicação.
Uso
$ brasa env list
Exemplo
$ brasa env list DATABASE_URL: postgres://user:****@host/db RAILS_ENV: production SECRET_KEY_BASE: **** REDIS_URL: redis://localhost:6379
brasa env remove
Remove uma variável de ambiente da aplicação.
Uso
$ brasa env remove KEY
Exemplo
$ brasa env remove REDIS_URL Variável REDIS_URL removida. Reiniciando app... OK
brasa scale
Escala os dynos (instâncias) da aplicação. Você pode escalar diferentes tipos de processo separadamente.
Uso
$ brasa scale TIPO=N [TIPO2=M ...]
Exemplo
$ brasa scale web=3 worker=2 Escalando web para 3 instâncias... OK Escalando worker para 2 instâncias... OK web.1: running web.2: running web.3: starting worker.1: running worker.2: starting
brasa domains add
Adiciona um domínio personalizado à aplicação. Após adicionar, configure o DNS conforme as instruções.
Uso
$ brasa domains add DOMÍNIO
Exemplo
$ brasa domains add app.meusite.com.br Domínio adicionado: app.meusite.com.br Configure o DNS com um registro CNAME: app.meusite.com.br -> meu-saas.usebrasa.com.br Execute "brasa domains verify app.meusite.com.br" após configurar.
brasa domains list
Lista todos os domínios configurados para a aplicação.
Uso
$ brasa domains list
Exemplo
$ brasa domains list Domínios de meu-saas: meu-saas.usebrasa.com.br (padrão) verificado app.meusite.com.br (custom) verificado api.meusite.com.br (custom) pendente
brasa domains remove
Remove um domínio personalizado da aplicação.
Uso
$ brasa domains remove DOMÍNIO
Exemplo
$ brasa domains remove api.meusite.com.br Domínio api.meusite.com.br removido.
brasa rollback
Reverte a aplicação para um deploy anterior. Sem argumentos, reverte para o deploy imediatamente anterior.
Uso
$ brasa rollback [DEPLOY_ID]
Opções
| Argumento | Descrição |
|---|---|
DEPLOY_ID | ID do deploy para o qual reverter (opcional) |
Exemplo
$ brasa rollback Revertendo para deploy #41... Restaurando imagem... OK Reiniciando containers... OK Rollback concluído! App rodando deploy #41.
brasa destroy
Destrói a aplicação permanentemente. Esta ação não pode ser desfeita. Requer confirmação.
Uso
$ brasa destroy [--confirm NOME]
Exemplo
$ brasa destroy Tem certeza que deseja destruir "meu-saas"? Digite o nome do app para confirmar: meu-saas Destruindo app... OK App "meu-saas" foi removido permanentemente.
brasa apps
Lista todas as aplicações da sua conta.
Uso
$ brasa apps
Exemplo
$ brasa apps Nome Stack Status Instâncias meu-saas rails-8.0 running web:2, worker:1 api-gateway node-20 running web:1 blog rails-8.0 stopped web:0
brasa db info
Exibe informações do banco de dados da aplicação, incluindo tipo, versão, tamanho e conexões.
Uso
$ brasa db info
Exemplo
$ brasa db info Banco de dados: meu-saas-db Tipo: PostgreSQL 16 Plano: standard Tamanho: 245 MB / 1 GB Conexões: 5 / 20 ativas Região: br-south-1 Último backup: 2025-01-15 03:00 UTC