CLI Reference

`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-se1`)

Exemplo

$ brasa init --name meu-saas
Detectado: Ruby on Rails 8.0
Região: br-se1 (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-se1
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 o número de réplicas (instâncias) da aplicação e/ou altera o preset de recursos.

Uso

$ brasa scale [--replicas N] [--preset micro|hobby|pro]

Exemplo

$ brasa scale --replicas 3
Escalando para 3 réplicas... OK
Réplicas: 3 (running)

$ brasa scale --preset pro
Preset atualizado para pro... OK

`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 deploy`

Faz um novo deploy da aplicação já existente no diretório atual.

Uso

$ brasa deploy [--branch BRANCH]

Opções

Opção	Descrição
`--branch`	Branch para o deploy

Exemplo

$ brasa deploy --branch main
Empacotando aplicação...
Construindo imagem... OK
Deploy concluído! https://meu-app.usebrasa.com.br

`brasa redis`

Gerencia o Redis (cache) da aplicação: status, enable e disable.

Uso

$ brasa redis status
$ brasa redis enable [--memory 256|512|1024]
$ brasa redis disable

Opções

Opção	Descrição
`--memory`	Memória em MB para o `enable` (256, 512 ou 1024; padrão 256)

Exemplo

$ brasa redis enable --memory 512
Provisionando Redis (512 MB)... OK
REDIS_URL injetada nas variáveis de ambiente.

`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 logs:search`

Busca full-text nos logs da aplicação (requer o add-on de Logs com busca).

Uso

$ brasa logs:search --query TERMO [--level LEVEL] [--source SOURCE] [--since 1h] [--limit 100]

Opções

Opção	Descrição
`--query`	Termo de busca (obrigatório)
`--level`	Filtrar por nível (error, warn, info)
`--source`	Filtrar por source (web, worker, system)
`--since`	Período (ex: 1h, 24h, 7d)
`--limit`	Limite de resultados (padrão 100)

Exemplo

$ brasa logs:search --query "error" --level error --since 24h

`brasa logs:export`

Exporta os logs da aplicação em JSON ou CSV (requer o add-on de Logs).

Uso

$ brasa logs:export [--format json|csv] [--since DATA] [--until DATA] [--level LEVEL]

Opções

Opção	Descrição
`--format`	Formato de exportação (json ou csv; padrão json)
`--since`	Data/hora inicial
`--until`	Data/hora final
`--level`	Filtrar por nível (error, warn, info)

Exemplo

$ brasa logs:export --format csv --since 2026-07-01 > logs.csv

`brasa version`

Exibe a versão instalada da CLI.

Uso

$ brasa version

Exemplo

$ brasa version
brasa 0.7.1

`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-se1
Último backup:  2025-01-15 03:00 UTC

brasa login

Uso

Opções

Exemplo

brasa init

Uso

Opções

Exemplo

brasa up

Uso

Opções

Exemplo

brasa status

Uso

Exemplo

brasa logs

Uso

Opções

Exemplo

brasa env set

Uso

Exemplo

brasa env list

Uso

Exemplo

brasa env remove

Uso

Exemplo

brasa scale

Uso

Exemplo

brasa domains add

Uso

Exemplo

brasa domains list

Uso

Exemplo

brasa domains remove

Uso

Exemplo

brasa deploy

Uso

Opções

Exemplo

brasa redis

Uso

Opções

Exemplo

brasa destroy

Uso

Exemplo

brasa logs:search

Uso

Opções

Exemplo

brasa logs:export

Uso

Opções

Exemplo

brasa version

Uso

Exemplo

brasa db info

Uso

Exemplo

Entre na lista de espera

`brasa login`

`brasa init`

`brasa up`

`brasa status`

`brasa logs`

`brasa env set`

`brasa env list`

`brasa env remove`

`brasa scale`

`brasa domains add`

`brasa domains list`

`brasa domains remove`

`brasa deploy`

`brasa redis`

`brasa destroy`

`brasa logs:search`

`brasa logs:export`

`brasa version`

`brasa db info`