CLI Reference

Referência completa dos comandos da CLI do Jataí. A CLI utiliza Thor e pode ser instalada via gem install jatai (página no RubyGems).

jatai login

Autentica o usuário na plataforma Jataí. Armazena o token de acesso localmente em ~/.jatai/credentials.

Uso

$ jatai login

Opções

FlagDescrição
--token TOKENAutentica usando um API token (sem prompt interativo)

Exemplo

$ jatai login
Email: dev@empresa.com.br
Senha: ********
Autenticado com sucesso! Token salvo em ~/.jatai/credentials

jatai init

Inicializa uma aplicação no diretório atual. Detecta automaticamente o stack (Rails, Node.js, estático ou Docker), pergunta o nome e o Hex e cria o arquivo .jatai.yml. É interativo: não recebe flags.

Uso

$ jatai init

O que ele pergunta

PerguntaDescrição
StackSó aparece se a detecção automática falhar ou você não confirmar
Nome do appO identificador (app:) é gerado a partir dele
Hexbase (R$ 29), escala_1 (R$ 59) ou escala_2 (R$ 119) — dá para trocar depois com jatai scale

Região e branch não são perguntados: region é sempre br-se1 enquanto a plataforma opera em região única, e o branch vem do Git. O banco também não é perguntado — todo app não-estático recebe um PG Base no jatai up.

Exemplo

$ jatai init
Stack detectado: Rails
Confirmar stack Rails? (Y/n) y
Nome do app: meu-saas
Hex: (Use ↑/↓ e Enter)
‣ Hex Base — R$ 29/mês (1 grátis por time)
  Hex Escala 1 — R$ 59/mês
  Hex Escala 2 — R$ 119/mês
Arquivo .jatai.yml criado com sucesso!
Branch: main
Banco: PG Base provisionado automaticamente no `jatai up`.
Execute `jatai up` para criar e fazer deploy do app.

jatai 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

$ jatai up [--branch BRANCH]

Opções

FlagDescrição
--branch BRANCHBranch do Git a ser deployado (padrão: branch atual)
--skip-buildPula a etapa de build (usa imagem existente)

Exemplo

$ jatai 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.jataiapp.com.br

jatai status

Exibe o status atual da aplicação: stack, Hex contratado, banco e informações do último deploy.

Uso

$ jatai status

Exemplo

$ jatai status
App: Meu SaaS
  Slug:    meu-saas
  Stack:   rails
  Status:  active
  Região:  br-se1
  Hex:     Hex Escala 1
  Banco:   PG Base
  URL:     https://meu-saas.jataiapp.com.br

Último deploy:
  ID:      42
  Status:  live
  Commit:  abc1234
  Data:    2026-08-24T10:00:00Z

jatai logs

Visualiza os logs da aplicação. Use a flag --tail para acompanhar em tempo real.

Uso

$ jatai logs [--tail] [--lines N]

Opções

FlagDescrição
--tailAcompanha logs em tempo real (streaming)
--lines NNúmero de linhas a exibir (padrão: 100)

Exemplo

$ jatai 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

jatai env set

Define uma variável de ambiente para a aplicação. O app é reiniciado automaticamente após a alteração.

Uso

$ jatai env set KEY=VALUE [KEY2=VALUE2 ...]

Exemplo

$ jatai 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

jatai env list

Lista todas as variáveis de ambiente configuradas para a aplicação.

Uso

$ jatai env list

Exemplo

$ jatai env list
DATABASE_URL:  postgres://user:****@host/db
RAILS_ENV:     production
SECRET_KEY_BASE: ****
REDIS_URL:     redis://localhost:6379

jatai env remove

Remove uma variável de ambiente da aplicação.

Uso

$ jatai env remove KEY

Exemplo

$ jatai env remove REDIS_URL
Variável REDIS_URL removida.
Reiniciando app... OK

jatai scale

Escala o número de réplicas (instâncias) da aplicação e/ou troca o Hex. Mostra o custo estimado e pede confirmação antes de aplicar. Cada réplica é um Hex inteiro — a segunda custa o mesmo que a primeira.

Uso

$ jatai scale [--replicas N] [--preset base|escala_1|escala_2]

Exemplo

$ jatai scale --replicas 3
Hex: Hex Escala 1
Réplicas: 3
CPU: 500m  |  RAM: 1Gi
Custo estimado: R$ 177.00/mês
Confirmar escalonamento? (Y/n) y
Escalonamento aplicado com sucesso!

$ jatai scale --preset escala_2
Hex: Hex Escala 2
Réplicas: 1
CPU: 1000m  |  RAM: 2Gi
Custo estimado: R$ 119.00/mês
Confirmar escalonamento? (Y/n) y
Escalonamento aplicado com sucesso!

jatai domains add

Adiciona um domínio personalizado à aplicação. Após adicionar, configure o DNS conforme as instruções.

Uso

$ jatai domains add DOMÍNIO

Exemplo

$ jatai 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.jataiapp.com.br
Execute "jatai domains verify app.meusite.com.br" após configurar.

jatai domains list

Lista todos os domínios configurados para a aplicação.

Uso

$ jatai domains list

Exemplo

$ jatai domains list
Domínios de meu-saas:
  meu-saas.jataiapp.com.br   (padrão)    verificado
  app.meusite.com.br            (custom)    verificado
  api.meusite.com.br            (custom)    pendente

jatai domains remove

Remove um domínio personalizado da aplicação.

Uso

$ jatai domains remove DOMÍNIO

Exemplo

$ jatai domains remove api.meusite.com.br
Domínio api.meusite.com.br removido.

jatai deploy

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

Uso

$ jatai deploy [--branch BRANCH]

Opções

OpçãoDescrição
--branchBranch para o deploy

Exemplo

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

jatai redis

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

Uso

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

Opções

OpçãoDescrição
--memoryMemória em MB para o enable (256, 512 ou 1024; padrão 256)

Exemplo

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

jatai destroy

Destrói a aplicação permanentemente. Esta ação não pode ser desfeita. Requer confirmação.

Uso

$ jatai destroy [--confirm NOME]

Exemplo

$ jatai 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.

jatai logs:search

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

Uso

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

Opções

OpçãoDescrição
--queryTermo de busca (obrigatório)
--levelFiltrar por nível (error, warn, info)
--sourceFiltrar por source (web, worker, system)
--sincePeríodo (ex: 1h, 24h, 7d)
--limitLimite de resultados (padrão 100)

Exemplo

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

jatai logs:export

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

Uso

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

Opções

OpçãoDescrição
--formatFormato de exportação (json ou csv; padrão json)
--sinceData/hora inicial
--untilData/hora final
--levelFiltrar por nível (error, warn, info)

Exemplo

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

jatai version

Exibe a versão instalada da CLI.

Uso

$ jatai version

Exemplo

$ jatai version
jatai 0.7.1

jatai db info

Exibe informações do banco de dados da aplicação, incluindo tipo, versão, tamanho e conexões.

Uso

$ jatai db info

Exemplo

$ jatai 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