CLI aura — Full reference

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/daylami/aurabase.git
cargo install --path aurabase/aura-cli
#    install the `aurabase` binary in ~/.cargo/bin
aurabase --help

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

Find all the commands and subcommands supported by the aura binary:

Project Setup & Management

Initialization, connection and diagnosis of the project

aura initInitializes 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 Token

aura register [--email <email>] [--password <pass>]Creates a new Aurabase Console developer account

aura logoutDisconnects the active local session

aura whoamiShows the logged in user, their organization, and the active project

aura link --project-id <uuid>Links the current directory to an existing cloud project

aura statusShows project status, connection and service status

aura doctorDiagnoses the local environment (Docker, ports, system tools)

Local Development

Local stack management (Kubernetes / k3d) and logs

aura startStarts all Aurabase local microservices on k3d

aura stopStops k3d cluster and local services

aura restartRestarts local services

aura devContinuous dev mode: monitors migrations and synchronizes types

aura studioOpens 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 connectOpens an interactive psql terminal directly connected to the database

Organizations & Cloud Projects

Multi-tenant management of organizations and projects

aura orgs list [--json]Lists the organizations of which you are a member

aura orgs create --name <name> --slug <slug>Creates a new Cloud organization

aura orgs use <slug>Sets the default organization for orders

aura projects list [--org <slug>] [--json]Lists an organization's projects

aura projects create <name> [--engine postgres|mongodb] [--org <slug>]Provisions a new project

aura projects delete <id>Permanently deletes a project and its data

aura projects api-keys [--project-id <id>]Shows the project's API keys (anon, service_role)

aura projects rename <id> <name>Renames an existing project

aura projects graphql-enable <id>Enables the GraphQL extension (pg_graphql) on the project

Database & Migrations (aura db)

Schema management, synchronization, push/pull and SQL queries

aura db pushApplies pending local SQL migrations (+ cloud sync if linked)

aura db pullRetrieves remote schema and updates local schema

aura db diff [--name <name>]Compares remote schema with local and generates SQL migration

aura db status [--json]Shows detailed status of applied and pending migrations

aura db watchMonitors schema changes and syncs live

aura db resetPurge and recreate local database from scratch

aura db seedRuns seed.sql script to load test data

aura db generateGenerates TypeScript Database type definitions

aura db raw "<sql>" [--params <p1> <p2>] [--dry-run] [--read-only] [--json]Runs a direct SQL query with simulation and read-only options

aura db migration new <name>Creates a new timestamped SQL migration file

aura db migration list [--json]Lists all project migrations and their status

aura 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

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 types

aura 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 constraints

aura db table rls <name> <on|off>Enables or disables Row Level Security protection on a table

aura db table realtime <name> <on|off>Enables or disables Realtime CDC publishing on a table

aura db policy list [--table <name>] [--json]Lists RLS security policies defined on tables

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 <name> <table> [--using-expr <expr>] [--check-expr <expr>]Modifies the USING / WITH CHECK expressions of a rule without breaking

aura db policy delete <name> <table> [-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 control

aura db function drop <name> [-f]Delete a Postgres SQL function

aura db trigger list <table> [--json]Lists all triggers in a table

aura 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 events

aura db trigger drop <table> <name> [-f]Delete a trigger on a table

Backups & API Keys (aura db backup / apikeys)

Snapshots, restoration and management of access tokens

aura db backup list [--json]Lists manual and automated backups of the database

aura db backup create [--label <label>]Generates an immediate snapshot of the database

aura db backup restore <id> [--verify-only]Restores a database from a specified snapshot

aura db backup download <id> [-o <path>]Download the complete SQL dump of a backup

aura db backup delete <id> [-f]Deletes a backup archive

aura db backup schedule get [--json]Consults the configured automatic backup schedule

aura db backup schedule set [--frequency hourly|daily|weekly] [--retention-days <n>] [--enable|--disable]Configures the frequency and retention duration of backups

aura db apikeys list [--json]Lists active API keys associated with the project

aura db apikeys create <name> [--scope anon|authenticated|service_role]Generates a new API key with a specific role

aura 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 project

aura auth users create [--email <email>] [--password <pass>]Creates a new user with password

aura auth users delete <id> [-f]Permanently delete a user

aura auth users ban <id>Bans a user and revokes their active sessions

aura auth users unban <id>Unban a user

aura auth sessions list [--json]List active JWT sessions

aura auth audit-log [--limit 50] [--json]View security audit logs and connection attempts

aura auth settings get [--json]Displays auth configuration (OAuth, MFA, timeouts)

aura auth settings set KEY=VALUE...Updates authentication settings

aura 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 template

aura 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 Function

aura functions deploy <name>Compiles to WASM binary and deploys the function to the global network

aura functions list [--json]Lists local and deployed functions with their status

aura functions logs <name>Displays the real-time log stream of a function

aura functions serveStarts the local test server for functions

aura functions invoke <name> [--data '<json>']Invoke and test a function deployed with a payload

aura functions download <name>Download the source code of a remote function

aura functions delete <name> [-f]Deletes a deployed Edge Function

aura secrets list --function <name> [--json]Lists secret variables configured for a function

aura secrets set --function <name> KEY=VALUE...Defines encrypted secrets injected into the function

aura 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 folder

aura storage cp <src> <dst>Transfer files (local ↔ bucket)

aura storage rm <path>Deletes a file stored in a bucket

aura storage mb <name> [--public]Creates a new bucket (private by default, or public)

aura storage buckets list [--json]Lists all storage buckets in the project

aura storage buckets create <name> [--public]Creates a storage bucket

aura 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 .env

aura env set KEY=VALUE...Sets one or more variables in the local .env

aura env unset KEY...Remove variables from local .env file

aura uiLaunches the full interactive TUI (Terminal User Interface)

aura updateAutomatically checks and updates the CLI to the latest stable version

aura completions <bash|zsh|fish|powershell|elvish>Generates auto-completion scripts for your shell

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

• --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