CLI Reference
Referencia completa dos comandos da CLI do Brasa. A CLI utiliza Thor e pode ser instalada via gem install brasa.
brasa login
Autentica o usuario na plataforma Brasa. Armazena o token de acesso localmente em ~/.brasa/credentials.
Uso
$ brasa login
Opcoes
| Flag | Descricao |
|---|---|
--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 aplicacao no diretorio atual. Detecta automaticamente o stack (Rails, Node.js, etc.) e cria o arquivo de configuracao brasa.yml.
Uso
$ brasa init [--name NOME] [--region REGIAO]
Opcoes
| Flag | Descricao |
|---|---|
--name NOME | Nome do app (inferido do diretorio se omitido) |
--region REGIAO | Regiao do deploy (padrao: br-south-1) |
Exemplo
$ brasa init --name meu-saas Detectado: Ruby on Rails 8.0 Regiao: br-south-1 (Sao Paulo) Arquivo brasa.yml criado. App "meu-saas" registrado com sucesso!
brasa up
Executa o deploy da aplicacao. Empacota o codigo, envia para a Magalu Cloud, constroi a imagem e inicia os containers.
Uso
$ brasa up [--branch BRANCH]
Opcoes
| Flag | Descricao |
|---|---|
--branch BRANCH | Branch do Git a ser deployado (padrao: branch atual) |
--skip-build | Pula a etapa de build (usa imagem existente) |
Exemplo
$ brasa up Empacotando aplicacao... OK Enviando para Magalu Cloud... OK (12.3 MB) Construindo imagem... OK (45s) Iniciando containers... OK Deploy #42 concluido! URL: https://meu-saas.usebrasa.com.br
brasa status
Exibe o status atual da aplicacao, incluindo instancias em execucao e informacoes do ultimo deploy.
Uso
$ brasa status
Exemplo
$ brasa status App: meu-saas Status: running Stack: Ruby on Rails 8.0 Region: br-south-1 Instancias: web.1 running healthy 256MB web.2 running healthy 256MB URL: https://meu-saas.usebrasa.com.br Ultimo deploy: #42 (ha 3 horas)
brasa logs
Visualiza os logs da aplicacao. Use a flag --tail para acompanhar em tempo real.
Uso
$ brasa logs [--tail] [--lines N]
Opcoes
| Flag | Descricao |
|---|---|
--tail | Acompanha logs em tempo real (streaming) |
--lines N | Numero de linhas a exibir (padrao: 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 variavel de ambiente para a aplicacao. O app e reiniciado automaticamente apos a alteracao.
Uso
$ brasa env set KEY=VALUE [KEY2=VALUE2 ...]
Exemplo
$ brasa env set DATABASE_URL=postgres://user:pass@host/db RAILS_ENV=production Variaveis definidas: DATABASE_URL = postgres://user:****@host/db RAILS_ENV = production Reiniciando app... OK
brasa env list
Lista todas as variaveis de ambiente configuradas para a aplicacao.
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 variavel de ambiente da aplicacao.
Uso
$ brasa env remove KEY
Exemplo
$ brasa env remove REDIS_URL Variavel REDIS_URL removida. Reiniciando app... OK
brasa scale
Escala os dynos (instancias) da aplicacao. Voce 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 instancias... OK Escalando worker para 2 instancias... OK web.1: running web.2: running web.3: starting worker.1: running worker.2: starting
brasa domains add
Adiciona um dominio personalizado a aplicacao. Apos adicionar, configure o DNS conforme as instrucoes.
Uso
$ brasa domains add DOMINIO
Exemplo
$ brasa domains add app.meusite.com.br Dominio 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" apos configurar.
brasa domains list
Lista todos os dominios configurados para a aplicacao.
Uso
$ brasa domains list
Exemplo
$ brasa domains list Dominios de meu-saas: meu-saas.usebrasa.com.br (padrao) verificado app.meusite.com.br (custom) verificado api.meusite.com.br (custom) pendente
brasa domains remove
Remove um dominio personalizado da aplicacao.
Uso
$ brasa domains remove DOMINIO
Exemplo
$ brasa domains remove api.meusite.com.br Dominio api.meusite.com.br removido.
brasa rollback
Reverte a aplicacao para um deploy anterior. Sem argumentos, reverte para o deploy imediatamente anterior.
Uso
$ brasa rollback [DEPLOY_ID]
Opcoes
| Argumento | Descricao |
|---|---|
DEPLOY_ID | ID do deploy para o qual reverter (opcional) |
Exemplo
$ brasa rollback Revertendo para deploy #41... Restaurando imagem... OK Reiniciando containers... OK Rollback concluido! App rodando deploy #41.
brasa destroy
Destroi a aplicacao permanentemente. Esta acao nao pode ser desfeita. Requer confirmacao.
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 aplicacoes da sua conta.
Uso
$ brasa apps
Exemplo
$ brasa apps Nome Stack Status Instancias 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 informacoes do banco de dados da aplicacao, incluindo tipo, versao, tamanho e conexoes.
Uso
$ brasa db info
Exemplo
$ brasa db info Banco de dados: meu-saas-db Tipo: PostgreSQL 16 Plano: standard Tamanho: 245 MB / 1 GB Conexoes: 5 / 20 ativas Regiao: br-south-1 Ultimo backup: 2025-01-15 03:00 UTC