CLI aura — Full reference
The official aura binary allows you to control the entire Aurabase platform: local dev, Kubernetes, SQL migrations, stored functions, Edge Functions WASM, RLS, Storage and Auth.
A standalone binary, available everywhere#
The CLI is a standalone Rust binary. It is installed today by NPM on macOS Apple Silicon, and by compilation from sources everywhere else. The precompiled binary packages for Linux, macOS Intel and Windows are not yet released: npm install -g @aurabase/cli fails there, this is not an error on your part.
# 1. NPM — macOS Apple Silicon only as of today
npm install -g @aurabase/cli
aura --help
# 2. From source — all platforms (Rust 1.7x+)
git clone https://github.com/Aurabase-cloud/Aurabase.git
cargo install --path Aurabase/aura-cli
# install the `aurabase` binary in ~/.cargo/bin
aurabase --help
Authenticate the CLI#
You can log in with your console account or using a Personal Access Token for your CI/CD pipelines:
# Interactive login (opens browser)
aura login
# Non-interactive connection (email / password)
aura login --email dev@example.com --password "secret"
# Connection via Personal Access Token (ideal for GitHub Actions / GitLab CI)
aura login --token aura_pat_9a8b7c6d5e4f...
# Check account and active project
aura whoami
Exhaustive reference per module#
Find all the commands and subcommands supported by the aura binary:
Project setup & management
Initialization, connection and diagnosis of the project
aura init— Initializes a new Aurabase project (structure, config, docker)aura login [--email <email>] [--password <pass>] [--token <pat>]— Logs in to the console account or with a Personal Access Tokenaura register [--email <email>] [--password <pass>]— Creates a new Aurabase Console developer accountaura logout— Disconnects the active local sessionaura whoami— Shows the logged in user, their organization, and the active projectaura link --project-id <uuid>— Links the current directory to an existing cloud projectaura status— Shows project status, connection and service statusaura doctor— Diagnoses the local environment (Docker, ports, system tools)
Local development
Local stack management (Kubernetes / k3d) and logs
aura start— Starts all Aurabase local microservices on k3daura stop— Stops k3d cluster and local servicesaura restart— Restarts local servicesaura dev— Continuous dev mode: monitors migrations and synchronizes typesaura studio— Opens the local Studio interface in your browser (localhost:3000)aura logs [-s <service>] [--since 1h] [--tail 100]— Displays logs unified or filtered by service (aura-auth, aura-db, gateway...)aura connect— Opens an interactive psql terminal on the project's direct PostgreSQL endpoint (psql asks for the password issued byaura db connection --new-password)
Organizations & cloud projects
Multi-tenant management of organizations and projects
aura orgs list [--json]— Lists the organizations of which you are a memberaura orgs create --name <name> --slug <slug>— Creates a new Cloud organizationaura orgs use <slug>— Sets the default organization for ordersaura projects list [--org <slug>] [--json]— Lists an organization's projectsaura projects create <name> [--engine postgres|mongodb] [--org <slug>]— Provisions a new projectaura projects delete <id>— Permanently deletes a project and its dataaura projects api-keys [--project-id <id>]— Shows the project's API keys (anon, service_role)aura projects rename <id> <name>— Renames an existing projectaura projects retry <id>— Re-runs the provisioning of a project inerrorand prints its URL and keys once it is readyaura projects graphql-enable <id> [--wait]— Enables the GraphQL extension (pg_graphql) on the projectaura projects graphql-config <id> [--introspection on|off] [--max-rows N] [--inflect-names on|off] [--wait]— Shows or changes the pg_graphql settings (without a flag, prints the settings in effect)
Database branches (aura branch)
A branch is a new project cloned from a PostgreSQL project, with its own URL and keys, deleted when its TTL ends. See database branches for the limits and what is cloned.
aura branch create <name> [--from <project id|slug|name>] [--org <slug>] [--ttl 72h|3d|2w] [--no-data] [--no-wait] [--json] [--timeout <s>]— Creates a branch of the linked project (or of--from), waits until it is ready, then prints its URL and its API keys once.--ttlgoes from 1h to 30d (default 72h).--no-datacopies the schema onlyaura branch list [--from <project>] [--all] [--json]— Lists the branches of a project, or of the whole organization with--all; failed branches stay listed for 24 hours with their reasonaura branch delete <name> [--from <project>] [--force]— Deletes a branch and its database
Database & migrations (aura db)
Schema management, synchronization, push/pull and SQL queries
aura db push— Applies pending local SQL migrations (+ cloud sync if linked)aura db pull— Retrieves remote schema and updates local schemaaura db diff [--name <name>]— Compares remote schema with local and generates SQL migrationaura db status [--json]— Shows detailed status of applied and pending migrationsaura db watch— Monitors schema changes and syncs liveaura db reset [--force]— Purge and recreate local database from scratch (asks for confirmation;--forcefor scripts)aura db seed— Runs seed.sql script to load test dataaura db generate [--lang ts|rust]— Generates TypeScript (default) or Rust Database type definitionsaura db extensions list [--json]/aura db extensions enable <name>— Lists the installed extensions, or enables an allowed oneaura db inspect <indexes|tables|locks> [--json]— Index usage (unused ones flagged), table sizes and dead rows, blocking locksaura db slow-queries [--limit <n>] [--json]— Lists the slowest SQL queries viapg_stat_statementsaura db stats [--json]— Shows connection stats and database disk usageaura db connection [--new-password] [--yes] [--json]— Direct PostgreSQL access (psql, Prisma, Drizzle,pg_dump): host, port, database and role; with--new-password, issues a password (shown once, never stored in clear, revokes the previous one) and prints the full connection stringaura db raw "<sql>" [--params <p1> <p2>] [--dry-run] [--read-only] [--json]— Runs a direct SQL query with simulation and read-only optionsaura db migration new <name>— Creates a new timestamped SQL migration fileaura db migration list [--json]— Lists all project migrations and their statusaura db migration down [n]— Cancels the last n migrations applied (default: 1)aura db migration repair <file> [--applied|--reverted]— Manually marks a migration as applied or canceled in the project's migration history (the same historyaura db statusandmigration listread)
RLS tables & policies (aura db table / policy)
Declarative creation, RLS, real-time CDC and permissions
aura db table list [--json]— Lists the public schema tables with their columns and typesaura db table create <name> "<cols>"— Creates a table (ex: "title:text,tags:text[],embedding:vector(1536)")aura db table drop <name> [-f]— Deletes a table and its constraintsaura db table rls <name> <on|off>— Enables or disables Row Level Security protection on a tableaura db table realtime <name> <on|off>— Enables or disables Realtime CDC publishing on a tableaura db policy list [--table <name>] [--all] [--json]— Lists RLS security policies defined on tables (--allincludes internal storage rules)aura db policy add <table> <name> <cmd> [--using-expr <expr>] [--check-expr <expr>]— Creates a new RLS policy (SELECT, INSERT, UPDATE, DELETE or ALL)aura db policy update <table> <name> [--using-expr <expr>] [--check-expr <expr>]— Modifies the USING / WITH CHECK expressions of a rule without breakingaura db policy delete <table> <name> [-f]— Deletes an RLS security rule
Postgres SQL functions & triggers (aura db function / trigger)
PL/pgSQL stored procedures and table triggers
aura db function list [--json]— Lists Postgres functions in the schema (name, arguments, security, rights)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>]— Creates or replaces a stored SQL function with strict access controlaura db function drop <name> [-f]— Delete a Postgres SQL functionaura db trigger list <table> [--json]— Lists all triggers in a tableaura db trigger create <table> <name> --function <fn> [--timing before|after|instead_of] --events insert,update [--for-each row|statement]— Binds a trigger function to table eventsaura db trigger drop <table> <name> [-f]— Delete a trigger on a table
Backups & API keys (aura db backup / api-keys)
Snapshots, restoration and management of access tokens
aura db backup list [--json]— Lists manual and automated backups of the databaseaura db backup create [--label <label>]— Generates an immediate snapshot of the databaseaura db backup restore <id> [--verify-only] [--yes]—--yes(or--force) skips the confirmation, required in scripts and CI; Restores a database from a specified snapshotaura db backup download <id> [-o <path>]— Download the complete SQL dump of a backupaura db backup delete <id> [-f]— Deletes a backup archiveaura db backup schedule get [--json]— Consults the configured automatic backup scheduleaura db backup schedule set [--frequency hourly|daily|weekly] [--retention-days <n>] [--enable|--disable]— Configures the frequency and retention duration of backupsaura db apikeys list [--json]— Lists active API keys associated with the projectaura db apikeys create <name> [--scope anon|authenticated|service_role]— Generates a new API key with a specific roleaura db apikeys revoke <id> [-f]— Immediately revokes an API key
Authentication & users (aura auth)
Management of accounts, sessions, audit logs and email templates
aura auth users list [--json]— Lists users registered in the projectaura auth users create [--email <email>] [--password <pass>] [--json]— Creates a new user with password (--jsonprints the created user, with itsid, for scripts)aura auth users delete <id> [-f]— Permanently delete a useraura auth users ban <id>— Bans a user and revokes their active sessionsaura auth users unban <id>— Unban a useraura auth sessions list [--json]— List active JWT sessionsaura auth audit-log [--limit 50] [--json]— View security audit logs and connection attemptsaura auth settings get [--json]— Displays auth configuration (OAuth, MFA, timeouts)aura auth settings set KEY=VALUE...— Updates authentication settingsaura auth email-templates list [--json]— List email templates (confirmation, reset, magic link)aura auth email-templates get <type>— Displays the HTML/text source code of a templateaura auth email-templates reset <type> [-f]— Resets a template to default values
Edge functions WASM & secrets (aura functions / secrets)
Deploying Edge Features and Encrypted Environment Variables
aura functions new <name>— Generates the skeleton of a new Edge Functionaura functions deploy <name>— Compiles to WASM binary and deploys the function to the global networkaura functions list [--json]— Lists local and deployed functions with their statusaura functions logs <name>— Displays the real-time log stream of a functionaura functions serve— Starts the local test server for functionsaura functions invoke <name> [--data '<json>']— Invoke and test a function deployed with a payloadaura functions download <name>— Download the source code of a remote functionaura functions delete <name> [-f]— Deletes a deployed Edge Functionaura secrets list --function <name> [--json]— Lists secret variables configured for a functionaura secrets set --function <name> KEY=VALUE...— Defines encrypted secrets injected into the functionaura secrets unset --function <name> KEY...— Removes one or more secrets from a function
Object storage (aura storage)
Bucket management and file transfer
aura storage ls [path]— Lists buckets or files in a folderaura storage cp <src> <dst>— Transfer files (local ↔ bucket)aura storage rm <path>— Deletes a file stored in a bucketaura storage mb <name> [--public]— Creates a new bucket (private by default, or public)aura storage buckets list [--json]— Lists all storage buckets in the projectaura storage buckets create <name> [--public]— Creates a storage bucketaura storage buckets delete <name> [-f]— Deletes a bucket and purges all of its objects
Local environment & utilities
.env variables, TUI interface, auto-update and auto-completion
aura env list [--json]— Shows variables defined in the local .envaura env set KEY=VALUE...— Sets one or more variables in the local .envaura env unset KEY...— Remove variables from local .env fileaura ui— Launches the full interactive TUI (Terminal User Interface)aura update— Automatically checks and updates the CLI to the latest stable versionaura completions <bash|zsh|fish|powershell|elvish>— Generates auto-completion scripts for your shell
Interactive interface in the terminal#
Aurabase integrates a text mode interface (aura ui) powered by Ratatui. It allows you to navigate your databases, execute SQL, inspect tables and follow logs without leaving your terminal.
# Launch the TUI interface
aura ui
Global options and settings#
--json— Structured JSON output (ideal for scripting, jq and CI/CD automation)--dry-run— Executes the command in a transaction rolled back at the end to validate the constraints without changing the data--read-only— Locks the transaction strictly read-only at the Postgres engine-f, --force— Ignores interactive confirmation requests for destructive operations--project-id <uuid>— Targets a specific remote project, ignoring the local linking file
Enable autocompletion in your shell to automatically tab commands:aura completions zsh > ~/.zfunc/_aura or aura completions bash > /etc/bash_completion.d/aura.