CLI-aura - Volledige referentie
Met het officiële aura-binaire bestand kunt u het volledige Aurabase-platform besturen: lokale dev, Kubernetes, SQL-migraties, opgeslagen functies, Edge Functions WASM, RLS, opslag en authenticatie.
Een op zichzelf staand binair bestand, overal beschikbaar#
De CLI is een zelfstandig binair Rust-bestand. Het wordt vandaag door NPM geïnstalleerd op macOS Apple Silicon en door compilatie van bronnen overal elders. De voorgecompileerde binaire pakketten voor Linux, macOS Intel en Windows zijn nog niet uitgebracht: npm install -g @aurabase/cli mislukt daar, dit is geen fout van uw kant.
# 1. NPM — vanaf vandaag alleen macOS Apple Silicon
npm install -g @aurabase/cli
aura --help
# 2. Van bron — alle platforms (Rust 1,7x+)
git clone https://github.com/Aurabase-cloud/Aurabase.git
cargo install --path Aurabase/aura-cli
# installeer het binaire bestand `aurabase` in ~/.cargo/bin
aurabase --help
Authenticeer de CLI#
U kunt inloggen met uw consoleaccount of met een persoonlijk toegangstoken voor uw CI/CD-pijplijnen:
# Interactief inloggen (opent browser)
aura login
# Niet-interactieve verbinding (e-mail / wachtwoord)
aura login --email dev@example.com --password "secret"
# Verbinding via persoonlijk toegangstoken (ideaal voor GitHub acties / GitLab CI)
aura login --token aura_pat_9a8b7c6d5e4f...
# Controleer account en actief project
aura whoami
Uitgebreide referentie per module#
Zoek alle opdrachten en subopdrachten die worden ondersteund door het binaire bestand aura:
Projectopzet en -beheer
Initialisatie, aansluiting en diagnose van het project
aura init— Initialiseert een nieuw Aurabase project (structuur, configuratie, docker)aura login [--email <email>] [--password <pass>] [--token <pat>]— Logt in op het consoleaccount of met een persoonlijk toegangstokenaura register [--email <email>] [--password <pass>]— Maakt een nieuw Aurabase Console-ontwikkelaarsaccount aanaura logout— Verbreekt de actieve lokale sessieaura whoami— Toont de ingelogde gebruiker, zijn organisatie en het actieve projectaura link --project-id <uuid>— Koppelt de huidige map aan een bestaand cloudprojectaura status— Toont de projectstatus, verbindings- en servicestatusaura doctor— Diagnose van de lokale omgeving (Docker, poorten, systeemtools)
Lokale ontwikkeling
Lokaal stapelbeheer (Kubernetes / k3d) en logs
aura start— Start alle Aurabase lokale microservices op k3daura stop— Stopt k3d-cluster en lokale servicesaura restart— Start lokale services opnieuwaura dev— Continue ontwikkelmodus: bewaakt migraties en synchroniseert typenaura studio— Opent de lokale Studio-interface in uw browser (localhost:3000)aura logs [-s <service>] [--since 1h] [--tail 100]— Geeft logboeken weer, verenigd of gefilterd op service (aura-auth, aura-db, gateway...)aura connect— Opent een interactieve psql-terminal op het directe PostgreSQL-eindpunt van het project (psql vraagt om het wachtwoord uitgegeven dooraura db connection --new-password)
Organisaties & cloudprojecten
Multi-tenant beheer van organisaties en projecten
aura orgs list [--json]— Geeft een overzicht van de organisaties waarvan u lid bentaura orgs create --name <name> --slug <slug>— Creëert een nieuwe cloudorganisatieaura orgs use <slug>— Stelt de standaardorganisatie voor bestellingen inaura projects list [--org <slug>] [--json]— Geeft een overzicht van de projecten van een organisatieaura projects create <name> [--engine postgres|mongodb] [--org <slug>]— Levert een nieuw project aanaura projects delete <id>— Verwijdert permanent een project en de bijbehorende gegevensaura projects api-keys [--project-id <id>]— Toont de API-sleutels van het project (anon, service_role)aura projects rename <id> <name>— Hernoemt een bestaand projectaura projects retry <id>— Voert de inrichting van een project opnieuw uit inerroren drukt de URL en sleutels af zodra deze gereed zijnaura projects graphql-enable <id> [--wait]— Schakelt de GraphQL-extensie (pg_graphql) in voor het projectaura projects graphql-config <id> [--introspection on|off] [--max-rows N] [--inflect-names on|off] [--wait]— Toont of wijzigt de pg_graphql-instellingen (zonder vlag, drukt de geldende instellingen af)
Databasetakken (auratak)
Een branch is een nieuw project dat is gekloond uit een PostgreSQL-project, met zijn eigen URL en sleutels, en verwijderd wanneer de TTL eindigt. Zie databasetakken voor de limieten en wat er wordt gekloond.
aura branch create <name> [--from <project id|slug|name>] [--org <slug>] [--ttl 72h|3d|2w] [--no-data] [--no-wait] [--json] [--timeout <s>]— Creëert een vertakking van het gekoppelde project (of van--from), wacht tot het klaar is en drukt vervolgens de URL en de API-sleutels één keer af.--ttlgaat van 1u tot 30d (standaard 72u).--no-datakopieert alleen het schemaaura branch list [--from <project>] [--all] [--json]— Geeft een overzicht van de takken van een project, of van de hele organisatie met--all; mislukte vestigingen blijven 24 uur op de lijst staan met hun redenaura branch delete <name> [--from <project>] [--force]— Verwijdert een filiaal en zijn database
Database & migraties (aura db)
Schemabeheer, synchronisatie, push/pull en SQL-query's
aura db push— Is van toepassing op lopende lokale SQL-migraties (+ cloudsynchronisatie indien gekoppeld)aura db pull— Haalt het externe schema op en werkt het lokale schema bijaura db diff [--name <name>]— Vergelijkt het externe schema met het lokale schema en genereert SQL-migratieaura db status [--json]— Toont gedetailleerde status van toegepaste en lopende migratiesaura db watch— Controleert schemawijzigingen en synchroniseert liveaura db reset [--force]— Lokale database leegmaken en opnieuw aanmaken (vraagt om bevestiging;--forcevoor scripts)aura db seed— Voert het seed.sql-script uit om testgegevens te ladenaura db generate [--lang ts|rust]— Genereert TypeScript (standaard) of Rust Databasetypedefinitiesaura db extensions list [--json]/aura db extensions enable <name>— Geeft een overzicht van de geïnstalleerde extensies, of schakelt een toegestane extensie inaura db inspect <indexes|tables|locks> [--json]— Indexgebruik (ongebruikte gemarkeerd), tabelgroottes en dode rijen, blokkerende vergrendelingenaura db slow-queries [--limit <n>] [--json]— Geeft een overzicht van de langzaamste SQL-query's viapg_stat_statementsaura db stats [--json]— Toont verbindingsstatistieken en databaseschijfgebruikaura db connection [--new-password] [--yes] [--json]— Directe PostgreSQL-toegang (psql, Prisma, Drizzle,pg_dump): host, poort, database en rol; met--new-passwordgeeft een wachtwoord uit (één keer weergegeven, nooit duidelijk opgeslagen, trekt het vorige in) en drukt de volledige verbindingsreeks afaura db raw "<sql>" [--params <p1> <p2>] [--dry-run] [--read-only] [--json]— Voert een directe SQL-query uit met simulatie- en alleen-lezen-optiesaura db migration new <name>— Maakt een nieuw SQL-migratiebestand met tijdstempelaura db migration list [--json]— Geeft een overzicht van alle projectmigraties en hun statusaura db migration down [n]— Annuleert de laatste n toegepaste migraties (standaard: 1)aura db migration repair <file> [--applied|--reverted]— Markeert handmatig een migratie als toegepast of geannuleerd in de migratiegeschiedenis van het project (dezelfde geschiedenisaura db statusenmigration listgelezen)
RLS tabellen en beleid (aura db tabel / beleid)
Declaratieve creatie, RLS, realtime CDC en machtigingen
aura db table list [--json]— Geeft een overzicht van de openbare schematabellen met hun kolommen en typenaura db table create <name> "<cols>"— Creëert een tabel (bijvoorbeeld: "title:text,tags:text[],embedding:vector(1536)")aura db table drop <name> [-f]— Verwijdert een tabel en zijn beperkingenaura db table rls <name> <on|off>— Schakelt beveiliging op rijniveau voor een tabel in of uitaura db table realtime <name> <on|off>— Schakelt Realtime CDC publiceren op een tabel in of uitaura db policy list [--table <name>] [--all] [--json]— Geeft een overzicht van het RLS-beveiligingsbeleid dat is gedefinieerd in tabellen (--allbevat interne opslagregels)aura db policy add <table> <name> <cmd> [--using-expr <expr>] [--check-expr <expr>]— Creëert een nieuw RLS beleid (SELECT, INSERT, UPDATE, DELETE of ALL)aura db policy update <table> <name> [--using-expr <expr>] [--check-expr <expr>]— Wijzigt de USING / WITH CHECK-expressies van een regel zonder te brekenaura db policy delete <table> <name> [-f]— Verwijdert een RLS beveiligingsregel
Postgres SQL-functies en triggers (aura db-functie / trigger)
PL/pgSQL opgeslagen procedures en tabeltriggers
aura db function list [--json]— Geeft Postgres-functies weer in het schema (naam, argumenten, beveiliging, rechten)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>]— Creëert of vervangt een opgeslagen SQL-functie met strikte toegangscontroleaura db function drop <name> [-f]— Verwijder een Postgres SQL-functieaura db trigger list <table> [--json]— Geeft een overzicht van alle triggers in een tabelaura db trigger create <table> <name> --function <fn> [--timing before|after|instead_of] --events insert,update [--for-each row|statement]— Bindt een triggerfunctie aan tabelgebeurtenissenaura db trigger drop <table> <name> [-f]— Verwijder een trigger uit een tabel
Back-ups en API-sleutels (aura db backup / api-sleutels)
Snapshots, herstel en beheer van toegangstokens
aura db backup list [--json]— Geeft handmatige en geautomatiseerde back-ups van de database weeraura db backup create [--label <label>]— Genereert onmiddellijk een momentopname van de databaseaura db backup restore <id> [--verify-only] [--yes]—--yes(of--force) slaat de bevestiging over, vereist in scripts en CI; Herstelt een database vanaf een opgegeven momentopnameaura db backup download <id> [-o <path>]— Download de volledige SQL-dump van een back-upaura db backup delete <id> [-f]— Verwijdert een back-uparchiefaura db backup schedule get [--json]— Raadpleegt het geconfigureerde automatische back-upschemaaura db backup schedule set [--frequency hourly|daily|weekly] [--retention-days <n>] [--enable|--disable]— Configureert de frequentie en bewaarduur van back-upsaura db apikeys list [--json]— Geeft actieve API-sleutels weer die aan het project zijn gekoppeldaura db apikeys create <name> [--scope anon|authenticated|service_role]— Genereert een nieuwe API-sleutel met een specifieke rolaura db apikeys revoke <id> [-f]— Trekt onmiddellijk een API-sleutel in
Authenticatie & gebruikers (aura auth)
Beheer van accounts, sessies, auditlogs en e-mailsjablonen
aura auth users list [--json]— Geeft een overzicht van de gebruikers die in het project zijn geregistreerdaura auth users create [--email <email>] [--password <pass>] [--json]— Creëert een nieuwe gebruiker met wachtwoord (--jsondrukt de aangemaakte gebruiker af, met zijnid, voor scripts)aura auth users delete <id> [-f]— Verwijder een gebruiker definitiefaura auth users ban <id>— Bant een gebruiker en trekt zijn actieve sessies inaura auth users unban <id>— De ban van een gebruiker opheffenaura auth sessions list [--json]— Lijst met actieve JWT-sessiesaura auth audit-log [--limit 50] [--json]— Bekijk beveiligingsauditlogboeken en verbindingspogingenaura auth settings get [--json]— Toont de auth-configuratie (OAuth, MFA, time-outs)aura auth settings set KEY=VALUE...— Werkt de authenticatie-instellingen bijaura auth email-templates list [--json]— Lijst met e-mailsjablonen (bevestiging, reset, magische link)aura auth email-templates get <type>— Toont de HTML/tekstbroncode van een sjabloonaura auth email-templates reset <type> [-f]— Reset een sjabloon naar de standaardwaarden
Randfuncties WASM & geheimen (aurafuncties / geheimen)
Implementatie van Edge-functies en gecodeerde omgevingsvariabelen
aura functions new <name>— Genereert het skelet van een nieuwe Edge-functieaura functions deploy <name>— Compileert naar binair WASM en implementeert de functie op het wereldwijde netwerkaura functions list [--json]— Geeft lokale en geïmplementeerde functies weer met hun statusaura functions logs <name>— Geeft de realtime logstroom van een functie weeraura functions serve— Start de lokale testserver voor functiesaura functions invoke <name> [--data '<json>']— Roep een functie aan en test deze die is geïmplementeerd met een payloadaura functions download <name>— Download de broncode van een externe functieaura functions delete <name> [-f]— Verwijdert een geïmplementeerde Edge-functieaura secrets list --function <name> [--json]— Geeft geheime variabelen weer die voor een functie zijn geconfigureerdaura secrets set --function <name> KEY=VALUE...— Definieert gecodeerde geheimen die in de functie worden geïnjecteerdaura secrets unset --function <name> KEY...— Verwijdert een of meer geheimen uit een functie
Objectopslag (auraopslag)
Bucketbeheer en bestandsoverdracht
aura storage ls [path]— Geeft buckets of bestanden in een map weeraura storage cp <src> <dst>— Bestanden overdragen (lokale ↔ bucket)aura storage rm <path>— Verwijdert een bestand dat is opgeslagen in een bucketaura storage mb <name> [--public]— Creëert een nieuwe bucket (standaard privé of openbaar)aura storage buckets list [--json]— Geeft een overzicht van alle opslagbuckets in het projectaura storage buckets create <name> [--public]— Creëert een opslagbucketaura storage buckets delete <name> [-f]— Verwijdert een bucket en verwijdert alle objecten ervan
Lokale omgeving en nutsvoorzieningen
.env-variabelen, TUI-interface, automatische update en automatische aanvulling
aura env list [--json]— Toont variabelen die zijn gedefinieerd in de lokale .envaura env set KEY=VALUE...— Stelt een of meer variabelen in de lokale .env inaura env unset KEY...— Verwijder variabelen uit het lokale .env-bestandaura ui— Lanceert de volledige interactieve TUI (Terminal User Interface)aura update— Controleert automatisch de CLI en werkt deze bij naar de nieuwste stabiele versieaura completions <bash|zsh|fish|powershell|elvish>— Genereert scripts voor automatisch aanvullen voor uw shell
Interactieve interface in de terminal#
Aurabase integreert een tekstmodusinterface (aura ui) mogelijk gemaakt door Ratatui. Hiermee kunt u door uw databases navigeren, SQL uitvoeren, tabellen inspecteren en logbestanden volgen zonder uw terminal te verlaten.
# Start de TUI-interface
aura ui
Globale opties en instellingen#
--json— Gestructureerde JSON-uitvoer (ideaal voor scripting, jq en CI/CD-automatisering)--dry-run— Voert de opdracht uit in een transactie die aan het einde is teruggedraaid om de beperkingen te valideren zonder de gegevens te wijzigen--read-only— Vergrendelt de transactie uitsluitend als alleen-lezen bij de Postgres-engine-f, --force— Negeert interactieve bevestigingsverzoeken voor destructieve bewerkingen--project-id <uuid>— Richt zich op een specifiek extern project, waarbij het lokale koppelingsbestand wordt genegeerd
Schakel automatisch aanvullen in uw shell in om automatisch opdrachten te tabbladen:aura completions zsh > ~/.zfunc/_aura of aura completions bash > /etc/bash_completion.d/aura.