Saltar al contenido
Logotipo de Aurabase
aurabase

Aura CLI: referencia completa

El binario oficial de aura le permite controlar toda la plataforma Aurabase: desarrollo local, Kubernetes, migraciones de SQL, funciones almacenadas, Edge Functions WASM, RLS, almacenamiento y autenticación.

Referencia12 min leerNivel referenciaRevisado el 19 ago 2026

Esta página fue traducida automáticamente. La versión en inglés es autorizada.

Un binario independiente, disponible en todas partes#

La CLI es un binario Rust independiente. Lo instala hoy NPM en macOS Apple Silicon y mediante compilación de fuentes en cualquier otro lugar. Los paquetes binarios precompilados para Linux, macOS Intel y Windows aún no se han publicado: npm install -g @aurabase/cli falla allí, esto no es un error de su parte.

terminalbash
# 1. NPM: macOS Apple Silicon solo a partir de hoy
npm install -g @aurabase/cli
aura --help

# 2. Desde la fuente: todas las plataformas (Rust 1.7x+)
git clone https://github.com/Aurabase-cloud/Aurabase.git
cargo install --path Aurabase/aura-cli
#    instale el binario `aurabase` en ~/.cargo/bin
aurabase --help

Autenticar la CLI#

Puede iniciar sesión con su cuenta de consola o utilizar un token de acceso personal para sus canalizaciones de CI/CD:

terminalbash
# Inicio de sesión interactivo (abre el navegador)
aura login

# Conexión no interactiva (correo electrónico/contraseña)
aura login --email dev@example.com --password "secret"

# Conexión mediante token de acceso personal (ideal para acciones GitHub/GitLab CI)
aura login --token aura_pat_9a8b7c6d5e4f...

# Consultar cuenta y proyecto activo
aura whoami

Referencia exhaustiva por módulo#

Encuentre todos los comandos y subcomandos admitidos por el binario aura:

Configuración y gestión de proyectos

Inicialización, conexión y diagnóstico del proyecto.

  • aura init: inicializa un nuevo proyecto Aurabase (estructura, configuración, ventana acoplable)
  • aura login [--email <email>] [--password <pass>] [--token <pat>]: inicia sesión en la cuenta de la consola o con un token de acceso personal
  • aura register [--email <email>] [--password <pass>]: crea una nueva cuenta de desarrollador de consola Aurabase
  • aura logout — Desconecta la sesión local activa
  • aura whoami: muestra el usuario que inició sesión, su organización y el proyecto activo.
  • aura link --project-id <uuid>: vincula el directorio actual a un proyecto de nube existente
  • aura status: muestra el estado del proyecto, la conexión y el servicio.
  • aura doctor: diagnostica el entorno local (Docker, puertos, herramientas del sistema)

Desarrollo local

Gestión de pila local (Kubernetes/k3d) y registros

  • aura start: inicia todos los microservicios locales Aurabase en k3d
  • aura stop — Detiene el clúster k3d y los servicios locales
  • aura restart — Reinicia los servicios locales
  • aura dev — Modo de desarrollo continuo: monitorea las migraciones y sincroniza los tipos
  • aura studio: abre la interfaz local de Studio en su navegador (localhost:3000)
  • aura logs [-s <service>] [--since 1h] [--tail 100] — Muestra registros unificados o filtrados por servicio (aura-auth, aura-db, gateway...)
  • aura connect: abre una terminal psql interactiva en el punto final directo PostgreSQL del proyecto (psql solicita la contraseña emitida por aura db connection --new-password).

Organizaciones y proyectos en la nube

Gestión multiinquilino de organizaciones y proyectos.

  • aura orgs list [--json]: enumera las organizaciones de las que es miembro
  • aura orgs create --name <name> --slug <slug>: crea una nueva organización en la nube
  • aura orgs use <slug>: establece la organización predeterminada para los pedidos.
  • aura projects list [--org <slug>] [--json] — Enumera los proyectos de una organización
  • aura projects create <name> [--engine postgres|mongodb] [--org <slug>] — Aprovisiona un nuevo proyecto
  • aura projects delete <id> — Elimina permanentemente un proyecto y sus datos
  • aura projects api-keys [--project-id <id>]: muestra las claves API del proyecto (anón, service_role)
  • aura projects rename <id> <name>: cambia el nombre de un proyecto existente
  • aura projects retry <id>: vuelve a ejecutar el aprovisionamiento de un proyecto en error e imprime su URL y claves una vez que esté listo.
  • aura projects graphql-enable <id> [--wait]: habilita la extensión GraphQL (pg_graphql) en el proyecto
  • aura projects graphql-config <id> [--introspection on|off] [--max-rows N] [--inflect-names on|off] [--wait]: muestra o cambia la configuración de pg_graphql (sin bandera, imprime la configuración vigente)

Ramas de base de datos (rama de aura)

Una rama es un nuevo proyecto clonado de un proyecto PostgreSQL, con su propia URL y claves, eliminado cuando finaliza su TTL. Consulte ramas de la base de datos para conocer los límites y lo que se clona.

  • aura branch create <name> [--from <project id|slug|name>] [--org <slug>] [--ttl 72h|3d|2w] [--no-data] [--no-wait] [--json] [--timeout <s>]: crea una rama del proyecto vinculado (o de --from), espera hasta que esté listo y luego imprime su URL y sus claves API una vez. --ttl pasa de 1h a 30d (72h predeterminado). --no-data copia solo el esquema
  • aura branch list [--from <project>] [--all] [--json]: enumera las ramas de un proyecto o de toda la organización con --all; Las sucursales fallidas permanecen en la lista durante 24 horas con su motivo.
  • aura branch delete <name> [--from <project>] [--force] — Elimina una rama y su base de datos

Base de datos y migraciones (aura db)

Gestión de esquemas, sincronización, push/pull y consultas SQL.

  • aura db push: se aplica a las migraciones SQL locales pendientes (+ sincronización en la nube si está vinculada)
  • aura db pull: recupera el esquema remoto y actualiza el esquema local.
  • aura db diff [--name <name>]: compara el esquema remoto con el local y genera una migración SQL
  • aura db status [--json]: muestra el estado detallado de las migraciones aplicadas y pendientes.
  • aura db watch: monitorea los cambios de esquema y las sincronizaciones en vivo
  • aura db reset [--force]: purga y vuelve a crear la base de datos local desde cero (solicita confirmación; --force para scripts)
  • aura db seed: ejecuta el script seed.sql para cargar datos de prueba
  • aura db generate [--lang ts|rust]: genera definiciones de tipo de base de datos TypeScript (predeterminado) o Rust
  • aura db extensions list [--json] / aura db extensions enable <name>: enumera las extensiones instaladas o habilita una permitida
  • aura db inspect <indexes|tables|locks> [--json]: uso de índices (los no utilizados marcados), tamaños de tablas y filas muertas, bloqueos
  • aura db slow-queries [--limit <n>] [--json]: enumera las consultas SQL más lentas a través de pg_stat_statements
  • aura db stats [--json]: muestra estadísticas de conexión y uso del disco de la base de datos.
  • aura db connection [--new-password] [--yes] [--json] — Acceso directo a PostgreSQL (psql, Prisma, Drizzle, pg_dump): host, puerto, base de datos y rol; con --new-password, emite una contraseña (se muestra una vez, nunca se almacena sin cifrar, revoca la anterior) e imprime la cadena de conexión completa
  • aura db raw "<sql>" [--params <p1> <p2>] [--dry-run] [--read-only] [--json]: ejecuta una consulta SQL directa con simulación y opciones de solo lectura
  • aura db migration new <name>: crea un nuevo archivo de migración SQL con marca de tiempo
  • aura db migration list [--json]: enumera todas las migraciones de proyectos y su estado.
  • aura db migration down [n]: cancela las últimas n migraciones aplicadas (predeterminado: 1)
  • aura db migration repair <file> [--applied|--reverted]: marca manualmente una migración como aplicada o cancelada en el historial de migración del proyecto (el mismo historial leído aura db status y migration list)

RLS tablas y políticas (tabla/política de aura db)

Creación declarativa, RLS, CDC en tiempo real y permisos

  • aura db table list [--json]: enumera las tablas de esquemas públicos con sus columnas y tipos.
  • aura db table create <name> "<cols>" — Crea una tabla (por ejemplo: "título:texto,etiquetas:texto[],incrustación:vector(1536)")
  • aura db table drop <name> [-f] — Elimina una tabla y sus restricciones
  • aura db table rls <name> <on|off>: habilita o deshabilita la protección de seguridad de nivel de fila en una tabla
  • aura db table realtime <name> <on|off>: habilita o deshabilita la publicación en tiempo real CDC en una tabla
  • aura db policy list [--table <name>] [--all] [--json]: enumera las políticas de seguridad RLS definidas en tablas (--all incluye reglas de almacenamiento interno)
  • aura db policy add <table> <name> <cmd> [--using-expr <expr>] [--check-expr <expr>]: crea una nueva política RLS (SELECCIONAR, INSERTAR, ACTUALIZAR, ELIMINAR o TODOS)
  • aura db policy update <table> <name> [--using-expr <expr>] [--check-expr <expr>] — Modifica las expresiones USING / FROM CHECK de una regla sin romperlas
  • aura db policy delete <table> <name> [-f]: elimina una regla de seguridad RLS

Postgres Funciones y activadores de SQL (función/activador de aura db)

Procedimientos almacenados PL/pgSQL y activadores de tablas

  • aura db function list [--json]: enumera las funciones Postgres en el esquema (nombre, argumentos, seguridad, derechos)
  • 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>]: crea o reemplaza una función SQL almacenada con un estricto control de acceso
  • aura db function drop <name> [-f] — Eliminar una función SQL Postgres
  • aura db trigger list <table> [--json]: enumera todos los desencadenantes en una tabla
  • aura db trigger create <table> <name> --function <fn> [--timing before|after|instead_of] --events insert,update [--for-each row|statement]: vincula una función de activación a eventos de tabla
  • aura db trigger drop <table> <name> [-f] — Eliminar un disparador en una tabla

Copias de seguridad y claves API (aura db backup / api-keys)

Instantáneas, restauración y gestión de tokens de acceso.

  • aura db backup list [--json]: enumera las copias de seguridad manuales y automáticas de la base de datos.
  • aura db backup create [--label <label>]: genera una instantánea inmediata de la base de datos
  • aura db backup restore <id> [--verify-only] [--yes] — --yes (o --force) omite la confirmación, requerida en scripts y CI; Restaura una base de datos a partir de una instantánea especificada
  • aura db backup download <id> [-o <path>] — Descargar el volcado SQL completo de una copia de seguridad
  • aura db backup delete <id> [-f]: elimina un archivo de copia de seguridad
  • aura db backup schedule get [--json] — Consulta el programa de copia de seguridad automático configurado
  • aura db backup schedule set [--frequency hourly|daily|weekly] [--retention-days <n>] [--enable|--disable]: configura la frecuencia y la duración de retención de las copias de seguridad.
  • aura db apikeys list [--json]: enumera las claves API activas asociadas con el proyecto.
  • aura db apikeys create <name> [--scope anon|authenticated|service_role]: genera una nueva clave API con una función específica
  • aura db apikeys revoke <id> [-f]: revoca inmediatamente una clave API

Autenticación y usuarios (aura auth)

Gestión de cuentas, sesiones, registros de auditoría y plantillas de correo electrónico.

  • aura auth users list [--json]: enumera los usuarios registrados en el proyecto.
  • aura auth users create [--email <email>] [--password <pass>] [--json] — Crea un nuevo usuario con contraseña (--json imprime el usuario creado, con su id, para scripts)
  • aura auth users delete <id> [-f] — Eliminar permanentemente un usuario
  • aura auth users ban <id> — Banea a un usuario y revoca sus sesiones activas
  • aura auth users unban <id> — Desbanear a un usuario
  • aura auth sessions list [--json] — Lista de sesiones activas JWT
  • aura auth audit-log [--limit 50] [--json] — Ver registros de auditoría de seguridad e intentos de conexión
  • aura auth settings get [--json]: muestra la configuración de autenticación (OAuth, MFA, tiempos de espera)
  • aura auth settings set KEY=VALUE... — Actualiza la configuración de autenticación
  • aura auth email-templates list [--json] — Lista de plantillas de correo electrónico (confirmación, reinicio, enlace mágico)
  • aura auth email-templates get <type>: muestra el código fuente HTML/texto de una plantilla.
  • aura auth email-templates reset <type> [-f]: restablece una plantilla a los valores predeterminados

Funciones de borde WASM y secretos (funciones de aura/secretos)

Implementación de funciones perimetrales y variables de entorno cifradas

  • aura functions new <name> — Genera el esqueleto de una nueva función Edge
  • aura functions deploy <name>: compila en binario WASM e implementa la función en la red global
  • aura functions list [--json]: enumera las funciones locales e implementadas con su estado
  • aura functions logs <name>: muestra el flujo de registro en tiempo real de una función.
  • aura functions serve: inicia el servidor de prueba local para funciones.
  • aura functions invoke <name> [--data '<json>']: invoca y prueba una función implementada con una carga útil
  • aura functions download <name> — Descargar el código fuente de una función remota
  • aura functions delete <name> [-f]: elimina una función perimetral implementada
  • aura secrets list --function <name> [--json]: enumera las variables secretas configuradas para una función
  • aura secrets set --function <name> KEY=VALUE...: define secretos cifrados inyectados en la función.
  • aura secrets unset --function <name> KEY...: elimina uno o más secretos de una función

Almacenamiento de objetos (almacenamiento de aura)

Gestión de depósitos y transferencia de archivos.

  • aura storage ls [path]: enumera depósitos o archivos en una carpeta
  • aura storage cp <src> <dst> — Transferir archivos (local ↔ depósito)
  • aura storage rm <path>: elimina un archivo almacenado en un depósito
  • aura storage mb <name> [--public]: crea un nuevo depósito (privado de forma predeterminada o público)
  • aura storage buckets list [--json]: enumera todos los depósitos de almacenamiento del proyecto.
  • aura storage buckets create <name> [--public]: crea un depósito de almacenamiento
  • aura storage buckets delete <name> [-f]: elimina un depósito y purga todos sus objetos.

Entorno local y servicios públicos

Variables .env, interfaz TUI, actualización automática y autocompletado

  • aura env list [--json]: muestra variables definidas en el .env local
  • aura env set KEY=VALUE...: establece una o más variables en el .env local
  • aura env unset KEY...: eliminar variables del archivo .env local
  • aura ui: inicia la TUI (interfaz de usuario de terminal) interactiva completa
  • aura update: comprueba y actualiza automáticamente la CLI a la última versión estable
  • aura completions <bash|zsh|fish|powershell|elvish> — Genera scripts de autocompletado para tu shell

Interfaz interactiva en la terminal#

Aurabase integra una interfaz en modo texto (aura ui) impulsada por Ratatui. Le permite navegar por sus bases de datos, ejecutar SQL, inspeccionar tablas y seguir registros sin salir de su terminal.

terminalbash
# Inicie la interfaz TUI
aura ui

Opciones y configuraciones globales#

  • --json — Salida JSON estructurada (ideal para scripting, jq y automatización CI/CD)
  • --dry-run: ejecuta el comando en una transacción revertida al final para validar las restricciones sin cambiar los datos.
  • --read-only: bloquea la transacción estrictamente de solo lectura en el motor Postgres
  • -f, --force: ignora las solicitudes de confirmación interactivas para operaciones destructivas
  • --project-id <uuid>: apunta a un proyecto remoto específico, ignorando el archivo de enlace local
Consejo

Habilite el autocompletado en su shell para tabular automáticamente los comandos:
aura completions zsh > ~/.zfunc/_aura o aura completions bash > /etc/bash_completion.d/aura.

para ir más lejos#