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.
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.
# 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:
# 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 pessoalaura register [--email <email>] [--password <pass>]— Cria uma nova conta de desenvolvedor do console Aurabaseaura logout— Desconecta a sessão local ativaaura whoami— Mostra o usuário logado, sua organização e o projeto ativoaura link --project-id <uuid>— Vincula o diretório atual a um projeto de nuvem existenteaura status— Mostra status do projeto, conexão e status do serviçoaura 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 k3daura stop— Interrompe o cluster k3d e os serviços locaisaura restart— Reinicia serviços locaisaura dev— Modo de desenvolvimento contínuo: monitora migrações e sincroniza tiposaura 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 poraura 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ê é membroaura orgs create --name <name> --slug <slug>— Cria uma nova organização em nuvemaura orgs use <slug>— Define a organização padrão para pedidosaura projects list [--org <slug>] [--json]— Lista os projetos de uma organizaçãoaura projects create <name> [--engine postgres|mongodb] [--org <slug>]— Provisiona um novo projetoaura projects delete <id>— Exclui permanentemente um projeto e seus dadosaura projects api-keys [--project-id <id>]— Mostra as chaves API do projeto (anon, service_role)aura projects rename <id> <name>— Renomeia um projeto existenteaura projects retry <id>— Executa novamente o provisionamento de um projeto emerrore imprime sua URL e chaves quando estiver prontoaura projects graphql-enable <id> [--wait]— Habilita a extensão GraphQL (pg_graphql) no projetoaura 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.--ttlvai de 1h a 30d (padrão 72h).--no-datacopia apenas o esquemaaura 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 motivoaura 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 localaura db diff [--name <name>]— Compara esquema remoto com local e gera migração SQLaura db status [--json]— Mostra o status detalhado das migrações aplicadas e pendentesaura db watch— Monitora alterações de esquema e sincroniza ao vivoaura db reset [--force]— Limpa e recria o banco de dados local do zero (pede confirmação;--forcepara scripts)aura db seed— Executa o script seed.sql para carregar dados de testeaura db generate [--lang ts|rust]— Gera definições de tipo de banco de dados TypeScript (padrão) ou Rustaura db extensions list [--json]/aura db extensions enable <name>— Lista as extensões instaladas ou habilita uma permitidaaura db inspect <indexes|tables|locks> [--json]— Uso de índice (não utilizados sinalizados), tamanhos de tabelas e linhas mortas, bloqueios de bloqueioaura db slow-queries [--limit <n>] [--json]— Lista as consultas SQL mais lentas viapg_stat_statementsaura db stats [--json]— Mostra estatísticas de conexão e uso do disco do banco de dadosaura 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 completaaura db raw "<sql>" [--params <p1> <p2>] [--dry-run] [--read-only] [--json]— Executa uma consulta SQL direta com simulação e opções somente leituraaura db migration new <name>— Cria um novo arquivo de migração SQL com carimbo de data/horaaura db migration list [--json]— Lista todas as migrações do projeto e seus statusaura 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óricoaura db statusemigration listlido)
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 tiposaura 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çõesaura db table rls <name> <on|off>— Habilita ou desabilita a proteção de segurança em nível de linha em uma tabelaaura db table realtime <name> <on|off>— Habilita ou desabilita a publicação CDC em tempo real em uma tabelaaura db policy list [--table <name>] [--all] [--json]— Lista políticas de segurança RLS definidas em tabelas (--allinclui 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 quebraraura 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 rigorosoaura db function drop <name> [-f]— Excluir uma função SQL Postgresaura db trigger list <table> [--json]— Lista todos os gatilhos em uma tabelaaura 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 tabelaaura 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 dadosaura db backup create [--label <label>]— Gera um instantâneo imediato do banco de dadosaura 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 especificadoaura db backup download <id> [-o <path>]— Baixe o dump SQL completo de um backupaura db backup delete <id> [-f]— Exclui um arquivo de backupaura db backup schedule get [--json]— Consulta o agendamento de backup automático configuradoaura 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 backupsaura db apikeys list [--json]— Lista chaves de API ativas associadas ao projetoaura db apikeys create <name> [--scope anon|authenticated|service_role]— Gera uma nova chave de API com uma função específicaaura 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 projetoaura auth users create [--email <email>] [--password <pass>] [--json]— Cria um novo usuário com senha (--jsonimprime o usuário criado, com seuid, para scripts)aura auth users delete <id> [-f]— Excluir permanentemente um usuárioaura auth users ban <id>— Bane um usuário e revoga suas sessões ativasaura auth users unban <id>— Desbanir um usuárioaura auth sessions list [--json]— Lista sessões JWT ativasaura auth audit-log [--limit 50] [--json]— Visualize registros de auditoria de segurança e tentativas de conexãoaura 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çãoaura 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 modeloaura 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 Functionaura functions deploy <name>— Compila para o binário WASM e implanta a função na rede globalaura functions list [--json]— Lista funções locais e implantadas com seus statusaura functions logs <name>— Exibe o fluxo de log em tempo real de uma funçãoaura functions serve— Inicia o servidor de teste local para funçõesaura functions invoke <name> [--data '<json>']— Invoque e teste uma função implantada com uma carga útilaura functions download <name>— Baixe o código fonte de uma função remotaaura functions delete <name> [-f]— Exclui uma função Edge implantadaaura secrets list --function <name> [--json]— Lista variáveis secretas configuradas para uma funçãoaura secrets set --function <name> KEY=VALUE...— Define segredos criptografados injetados na funçãoaura 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 pastaaura storage cp <src> <dst>— Transferir arquivos (local ↔ bucket)aura storage rm <path>— Exclui um arquivo armazenado em um bucketaura 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 projetoaura storage buckets create <name> [--public]— Cria um bucket de armazenamentoaura 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 localaura env set KEY=VALUE...— Define uma ou mais variáveis no .env localaura env unset KEY...— Remove variáveis do arquivo .env localaura ui— Inicia a TUI (Terminal User Interface) interativa completaaura update— Verifica e atualiza automaticamente a CLI para a versão estável mais recenteaura 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.
# 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
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.