Ir para o conteúdo
Aura Logo
aurabase

Aura CLI – Referência completa

O binário oficial da aura permite que você controle toda a plataforma Aurabase: desenvolvimento local, Kubernetes, migrações SQL, funções armazenadas, Edge Functions WASM, RLS, Armazenamento e Auth.

Referência12 min lidoNível referênciaRevisado em 19 de ago. de 2026

Esta página foi traduzida automaticamente. A versão em inglês é oficial.

Um binário independente, disponível em qualquer lugar#

A CLI é um binário Rust independente. Ele é instalado hoje pelo NPM em macOS Apple Silicon e por compilação de fontes em qualquer outro lugar. Os pacotes binários pré-compilados para Linux, macOS Intel e Windows ainda não foram lançados: npm install -g @aurabase/cli falha aí, isso não é um erro de sua parte.

terminalbash
# 1. NPM – macOS Apple Silicon somente a partir de hoje
npm install -g @aurabase/cli
aura --help

# 2. Da fonte – todas as plataformas (Rust 1.7x+)
git clone https://github.com/Aurabase-cloud/Aurabase.git
cargo install --path Aurabase/aura-cli
#    instale o binário `aurabase` em ~/.cargo/bin
aurabase --help

Autenticar a CLI#

Você pode fazer login com sua conta de console ou usando um token de acesso pessoal para seus pipelines de CI/CD:

terminalbash
# Login interativo (abre o navegador)
aura login

# Conexão não interativa (e-mail/senha)
aura login --email dev@example.com --password "secret"

# Conexão via token de acesso pessoal (ideal para ações GitHub / GitLab CI)
aura login --token aura_pat_9a8b7c6d5e4f...

# Verifique a conta e o projeto ativo
aura whoami

Referência exaustiva por módulo#

Encontre todos os comandos e subcomandos suportados pelo binário aura:

Configuração e gerenciamento de projetos

Inicialização, conexão e diagnóstico do projeto

  • aura init — Inicializa um novo projeto Aurabase (estrutura, configuração, docker)
  • aura login [--email <email>] [--password <pass>] [--token <pat>] — Efetua login na conta do console ou com um token de acesso pessoal
  • aura register [--email <email>] [--password <pass>] — Cria uma nova conta de desenvolvedor do console Aurabase
  • aura logout — Desconecta a sessão local ativa
  • aura whoami — Mostra o usuário logado, sua organização e o projeto ativo
  • aura link --project-id <uuid> — Vincula o diretório atual a um projeto de nuvem existente
  • aura status — Mostra status do projeto, conexão e status do serviço
  • aura doctor — Diagnostica o ambiente local (Docker, portas, ferramentas do sistema)

Desenvolvimento local

Gerenciamento de pilha local (Kubernetes/k3d) e logs

  • aura start — Inicia todos os microsserviços locais Aurabase no k3d
  • aura stop — Interrompe o cluster k3d e os serviços locais
  • aura restart — Reinicia serviços locais
  • aura dev — Modo de desenvolvimento contínuo: monitora migrações e sincroniza tipos
  • aura studio — Abre a interface local do Studio em seu navegador (localhost:3000)
  • aura logs [-s <service>] [--since 1h] [--tail 100] — Exibe logs unificados ou filtrados por serviço (aura-auth, aura-db, gateway...)
  • aura connect — Abre um terminal psql interativo no endpoint PostgreSQL direto do projeto (o psql pede a senha emitida por aura db connection --new-password)

Organizações e projetos na nuvem

Gerenciamento multilocatário de organizações e projetos

  • aura orgs list [--json] — Lista as organizações das quais você é membro
  • aura orgs create --name <name> --slug <slug> — Cria uma nova organização em nuvem
  • aura orgs use <slug> — Define a organização padrão para pedidos
  • aura projects list [--org <slug>] [--json] — Lista os projetos de uma organização
  • aura projects create <name> [--engine postgres|mongodb] [--org <slug>] — Provisiona um novo projeto
  • aura projects delete <id> — Exclui permanentemente um projeto e seus dados
  • aura projects api-keys [--project-id <id>] — Mostra as chaves API do projeto (anon, service_role)
  • aura projects rename <id> <name> — Renomeia um projeto existente
  • aura projects retry <id> — Executa novamente o provisionamento de um projeto em error e imprime sua URL e chaves quando estiver pronto
  • aura projects graphql-enable <id> [--wait] — Habilita a extensão GraphQL (pg_graphql) no projeto
  • aura projects graphql-config <id> [--introspection on|off] [--max-rows N] [--inflect-names on|off] [--wait] — Mostra ou altera as configurações de pg_graphql (sem flag, imprime as configurações em vigor)

Ramos de banco de dados (ramo aura)

Um branch é um novo projeto clonado de um projeto PostgreSQL, com URL e chaves próprias, deletadas quando seu TTL termina. Consulte ramificações do banco de dados para obter os limites e o que é clonado.

  • aura branch create <name> [--from <project id|slug|name>] [--org <slug>] [--ttl 72h|3d|2w] [--no-data] [--no-wait] [--json] [--timeout <s>] — Cria uma ramificação do projeto vinculado (ou de --from), espera até que esteja pronto e imprime sua URL e suas chaves de API uma vez. --ttl vai de 1h a 30d (padrão 72h). --no-data copia apenas o esquema
  • aura branch list [--from <project>] [--all] [--json] — Lista as ramificações de um projeto, ou de toda a organização com --all; filiais com falha permanecem listadas por 24 horas com o motivo
  • aura branch delete <name> [--from <project>] [--force] — Exclui uma filial e seu banco de dados

Banco de dados e migrações (aura db)

Gerenciamento de esquema, sincronização, push/pull e consultas SQL

  • aura db push — Aplica migrações SQL locais pendentes (+ sincronização na nuvem se vinculada)
  • aura db pull — Recupera o esquema remoto e atualiza o esquema local
  • aura db diff [--name <name>] — Compara esquema remoto com local e gera migração SQL
  • aura db status [--json] — Mostra o status detalhado das migrações aplicadas e pendentes
  • aura db watch — Monitora alterações de esquema e sincroniza ao vivo
  • aura db reset [--force] — Limpa e recria o banco de dados local do zero (pede confirmação; --force para scripts)
  • aura db seed — Executa o script seed.sql para carregar dados de teste
  • aura db generate [--lang ts|rust] — Gera definições de tipo de banco de dados TypeScript (padrão) ou Rust
  • aura db extensions list [--json] / aura db extensions enable <name> — Lista as extensões instaladas ou habilita uma permitida
  • aura db inspect <indexes|tables|locks> [--json] — Uso de índice (não utilizados sinalizados), tamanhos de tabelas e linhas mortas, bloqueios de bloqueio
  • aura db slow-queries [--limit <n>] [--json] — Lista as consultas SQL mais lentas via pg_stat_statements
  • aura db stats [--json] — Mostra estatísticas de conexão e uso do disco do banco de dados
  • aura db connection [--new-password] [--yes] [--json] — Acesso direto PostgreSQL (psql, Prisma, Drizzle, pg_dump): host, porta, banco de dados e função; com --new-password, emite uma senha (mostrada uma vez, nunca armazenada de forma clara, revoga a anterior) e imprime a string de conexão completa
  • aura db raw "<sql>" [--params <p1> <p2>] [--dry-run] [--read-only] [--json] — Executa uma consulta SQL direta com simulação e opções somente leitura
  • aura db migration new <name> — Cria um novo arquivo de migração SQL com carimbo de data/hora
  • aura db migration list [--json] — Lista todas as migrações do projeto e seus status
  • aura db migration down [n] — Cancela as últimas n migrações aplicadas (padrão: 1)
  • aura db migration repair <file> [--applied|--reverted] — Marca manualmente uma migração como aplicada ou cancelada no histórico de migração do projeto (o mesmo histórico aura db status e migration list lido)

RLS tabelas e políticas (tabela/política do banco de dados aura)

Criação declarativa, RLS, CDC em tempo real e permissões

  • aura db table list [--json] — Lista as tabelas de esquema público com suas colunas e tipos
  • aura db table create <name> "<cols>" — Cria uma tabela (ex: "title:text,tags:text[],embedding:vector(1536)")
  • aura db table drop <name> [-f] — Exclui uma tabela e suas restrições
  • aura db table rls <name> <on|off> — Habilita ou desabilita a proteção de segurança em nível de linha em uma tabela
  • aura db table realtime <name> <on|off> — Habilita ou desabilita a publicação CDC em tempo real em uma tabela
  • aura db policy list [--table <name>] [--all] [--json] — Lista políticas de segurança RLS definidas em tabelas (--all inclui regras de armazenamento interno)
  • aura db policy add <table> <name> <cmd> [--using-expr <expr>] [--check-expr <expr>] — Cria uma nova política RLS (SELECT, INSERT, UPDATE, DELETE ou ALL)
  • aura db policy update <table> <name> [--using-expr <expr>] [--check-expr <expr>] — Modifica as expressões USING / WITH CHECK de uma regra sem quebrar
  • aura db policy delete <table> <name> [-f] — Exclui uma regra de segurança RLS

Postgres Funções e gatilhos SQL (função/gatilho aura db)

Procedimentos armazenados PL/pgSQL e gatilhos de tabela

  • aura db function list [--json] — Lista funções Postgres no esquema (nome, argumentos, segurança, direitos)
  • aura db function create <name> [--body <sql>|--body-file <f>] [--returns <t>] [--language plpgsql|sql] [--args <a:t>] [--security invoker|definer] [--grant-execute-to <roles>] — Cria ou substitui uma função SQL armazenada com controle de acesso rigoroso
  • aura db function drop <name> [-f] — Excluir uma função SQL Postgres
  • aura db trigger list <table> [--json] — Lista todos os gatilhos em uma tabela
  • aura db trigger create <table> <name> --function <fn> [--timing before|after|instead_of] --events insert,update [--for-each row|statement] — Vincula uma função de gatilho a eventos de tabela
  • aura db trigger drop <table> <name> [-f] — Exclui um gatilho em uma tabela

Backups e chaves de API (aura db backup / api-keys)

Instantâneos, restauração e gerenciamento de tokens de acesso

  • aura db backup list [--json] — Lista backups manuais e automatizados do banco de dados
  • aura db backup create [--label <label>] — Gera um instantâneo imediato do banco de dados
  • aura db backup restore <id> [--verify-only] [--yes] — --yes (ou --force) ignora a confirmação, exigida em scripts e CI; Restaura um banco de dados de um snapshot especificado
  • aura db backup download <id> [-o <path>] — Baixe o dump SQL completo de um backup
  • aura db backup delete <id> [-f] — Exclui um arquivo de backup
  • aura db backup schedule get [--json] — Consulta o agendamento de backup automático configurado
  • aura db backup schedule set [--frequency hourly|daily|weekly] [--retention-days <n>] [--enable|--disable] — Configura a frequência e a duração da retenção dos backups
  • aura db apikeys list [--json] — Lista chaves de API ativas associadas ao projeto
  • aura db apikeys create <name> [--scope anon|authenticated|service_role] — Gera uma nova chave de API com uma função específica
  • aura db apikeys revoke <id> [-f] — Revoga imediatamente uma chave de API

Autenticação e usuários (autenticação aura)

Gerenciamento de contas, sessões, registros de auditoria e modelos de e-mail

  • aura auth users list [--json] — Lista os usuários cadastrados no projeto
  • aura auth users create [--email <email>] [--password <pass>] [--json] — Cria um novo usuário com senha (--json imprime o usuário criado, com seu id, para scripts)
  • aura auth users delete <id> [-f] — Excluir permanentemente um usuário
  • aura auth users ban <id> — Bane um usuário e revoga suas sessões ativas
  • aura auth users unban <id> — Desbanir um usuário
  • aura auth sessions list [--json] — Lista sessões JWT ativas
  • aura auth audit-log [--limit 50] [--json] — Visualize registros de auditoria de segurança e tentativas de conexão
  • aura auth settings get [--json] — Exibe configuração de autenticação (OAuth, MFA, tempos limite)
  • aura auth settings set KEY=VALUE... — Atualiza as configurações de autenticação
  • aura auth email-templates list [--json] — Lista modelos de e-mail (confirmação, redefinição, link mágico)
  • aura auth email-templates get <type> — Exibe o código-fonte HTML/texto de um modelo
  • aura auth email-templates reset <type> [-f] — Redefine um modelo para os valores padrão

Funções de borda WASM e segredos (funções/segredos da aura)

Implantando recursos de borda e variáveis de ambiente criptografadas

  • aura functions new <name> — Gera o esqueleto de uma nova Edge Function
  • aura functions deploy <name> — Compila para o binário WASM e implanta a função na rede global
  • aura functions list [--json] — Lista funções locais e implantadas com seus status
  • aura functions logs <name> — Exibe o fluxo de log em tempo real de uma função
  • aura functions serve — Inicia o servidor de teste local para funções
  • aura functions invoke <name> [--data '<json>'] — Invoque e teste uma função implantada com uma carga útil
  • aura functions download <name> — Baixe o código fonte de uma função remota
  • aura functions delete <name> [-f] — Exclui uma função Edge implantada
  • aura secrets list --function <name> [--json] — Lista variáveis secretas configuradas para uma função
  • aura secrets set --function <name> KEY=VALUE... — Define segredos criptografados injetados na função
  • aura secrets unset --function <name> KEY... — Remove um ou mais segredos de uma função

Armazenamento de objetos (armazenamento de aura)

Gerenciamento de bucket e transferência de arquivos

  • aura storage ls [path] — Lista buckets ou arquivos em uma pasta
  • aura storage cp <src> <dst> — Transferir arquivos (local ↔ bucket)
  • aura storage rm <path> — Exclui um arquivo armazenado em um bucket
  • aura storage mb <name> [--public] — Cria um novo bucket (privado por padrão ou público)
  • aura storage buckets list [--json] — Lista todos os buckets de armazenamento no projeto
  • aura storage buckets create <name> [--public] — Cria um bucket de armazenamento
  • aura storage buckets delete <name> [-f] — Exclui um bucket e limpa todos os seus objetos

Meio ambiente local e serviços públicos

Variáveis .env, interface TUI, atualização automática e preenchimento automático

  • aura env list [--json] — Mostra variáveis definidas no .env local
  • aura env set KEY=VALUE... — Define uma ou mais variáveis no .env local
  • aura env unset KEY... — Remove variáveis do arquivo .env local
  • aura ui — Inicia a TUI (Terminal User Interface) interativa completa
  • aura update — Verifica e atualiza automaticamente a CLI para a versão estável mais recente
  • aura completions <bash|zsh|fish|powershell|elvish> — Gera scripts de preenchimento automático para seu shell

Interface interativa no terminal#

Aurabase integra uma interface em modo texto (aura ui) desenvolvida pela Ratatui. Ele permite que você navegue em seus bancos de dados, execute SQL, inspecione tabelas e acompanhe logs sem sair do terminal.

terminalbash
# Inicie a interface TUI
aura ui

Opções e configurações globais#

  • --json — Saída JSON estruturada (ideal para scripts, automação jq e CI/CD)
  • --dry-run — Executa o comando em uma transação revertida no final para validar as restrições sem alterar os dados
  • --read-only — Bloqueia a transação estritamente somente leitura no mecanismo Postgres
  • -f, --force — Ignora solicitações de confirmação interativas para operações destrutivas
  • --project-id <uuid> — Tem como alvo um projeto remoto específico, ignorando o arquivo de link local
Dica

Habilite o preenchimento automático em seu shell para tabular automaticamente os comandos:
aura completions zsh > ~/.zfunc/_aura ou aura completions bash > /etc/bash_completion.d/aura.

Para ir mais longe#