CLI-Aura – Vollständige Referenz
Mit der offiziellen Aura-Binärdatei können Sie die gesamte Aurabase-Plattform steuern: lokale Entwicklung, Kubernetes, SQL-Migrationen, gespeicherte Funktionen, Edge Functions WASM, RLS, Speicher und Auth.
Eine eigenständige Binärdatei, die überall verfügbar ist#
Die CLI ist eine eigenständige Rust-Binärdatei. Es wird heute von NPM auf macOS Apple Silicon und durch Kompilierung aus Quellen überall sonst installiert. Die vorkompilierten Binärpakete für Linux, macOS Intel und Windows sind noch nicht freigegeben: npm install -g @aurabase/cli schlägt dort fehl, das ist kein Fehler Ihrerseits.
# 1. NPM – macOS Apple Silicon nur ab heute
npm install -g @aurabase/cli
aura --help
# 2. Aus der Quelle – alle Plattformen (Rust 1.7x+)
git clone https://github.com/Aurabase-cloud/Aurabase.git
cargo install --path Aurabase/aura-cli
# Installieren Sie die „aurabase“-Binärdatei in ~/.cargo/bin
aurabase --help
Authentifizieren Sie die CLI#
Sie können sich mit Ihrem Konsolenkonto anmelden oder ein persönliches Zugriffstoken für Ihre CI/CD-Pipelines verwenden:
# Interaktive Anmeldung (öffnet Browser)
aura login
# Nicht-interaktive Verbindung (E-Mail / Passwort)
aura login --email dev@example.com --password "secret"
# Verbindung über Personal Access Token (ideal für GitHub Actions / GitLab CI)
aura login --token aura_pat_9a8b7c6d5e4f...
# Konto und aktives Projekt prüfen
aura whoami
Ausführliche Referenz pro Modul#
Finden Sie alle Befehle und Unterbefehle, die von der Binärdatei aura unterstützt werden:
Projektaufbau und -management
Initialisierung, Verbindung und Diagnose des Projekts
aura init– Initialisiert ein neues Aurabase-Projekt (Struktur, Konfiguration, Docker)aura login [--email <email>] [--password <pass>] [--token <pat>]– Meldet sich beim Konsolenkonto oder mit einem persönlichen Zugriffstoken anaura register [--email <email>] [--password <pass>]– Erstellt ein neues Aurabase Konsolenentwicklerkontoaura logout– Trennt die aktive lokale Sitzungaura whoami– Zeigt den angemeldeten Benutzer, seine Organisation und das aktive Projekt anaura link --project-id <uuid>– Verknüpft das aktuelle Verzeichnis mit einem vorhandenen Cloud-Projektaura status– Zeigt Projektstatus, Verbindung und Dienststatus anaura doctor– Diagnostiziert die lokale Umgebung (Docker, Ports, Systemtools)
Lokale Entwicklung
Lokale Stack-Verwaltung (Kubernetes/k3d) und Protokolle
aura start– Startet alle Aurabase lokalen Microservices auf k3daura stop– Stoppt k3d-Cluster und lokale Diensteaura restart– Startet lokale Dienste neuaura dev– Kontinuierlicher Entwicklungsmodus: Überwacht Migrationen und synchronisiert Typenaura studio– Öffnet die lokale Studio-Oberfläche in Ihrem Browser (localhost:3000)aura logs [-s <service>] [--since 1h] [--tail 100]– Zeigt Protokolle vereinheitlicht oder gefiltert nach Dienst an (aura-auth, aura-db, Gateway...)aura connect– Öffnet ein interaktives psql-Terminal auf dem direkten Endpunkt PostgreSQL des Projekts (psql fragt nach dem vonaura db connection --new-passwordausgegebenen Passwort)
Organisationen und Cloud-Projekte
Mandantenfähige Verwaltung von Organisationen und Projekten
aura orgs list [--json]– Listet die Organisationen auf, bei denen Sie Mitglied sindaura orgs create --name <name> --slug <slug>– Erstellt eine neue Cloud-Organisationaura orgs use <slug>– Legt die Standardorganisation für Bestellungen festaura projects list [--org <slug>] [--json]– Listet die Projekte einer Organisation aufaura projects create <name> [--engine postgres|mongodb] [--org <slug>]– Stellt ein neues Projekt bereitaura projects delete <id>– Löscht ein Projekt und seine Daten dauerhaftaura projects api-keys [--project-id <id>]– Zeigt die API-Schlüssel des Projekts an (anon, service_role)aura projects rename <id> <name>– Benennt ein vorhandenes Projekt umaura projects retry <id>– Führt die Bereitstellung eines Projekts inerrorerneut aus und gibt seine URL und Schlüssel aus, sobald es bereit istaura projects graphql-enable <id> [--wait]– Aktiviert die GraphQL-Erweiterung (pg_graphql) für das Projektaura projects graphql-config <id> [--introspection on|off] [--max-rows N] [--inflect-names on|off] [--wait]– Zeigt die pg_graphql-Einstellungen an oder ändert sie (ohne Flag werden die gültigen Einstellungen gedruckt)
Datenbankzweige (Aura-Zweig)
Ein Zweig ist ein neues Projekt, das aus einem PostgreSQL-Projekt geklont wurde, mit eigener URL und eigenen Schlüsseln und gelöscht wird, wenn seine TTL endet. Siehe Datenbankzweige für die Grenzwerte und was geklont wird.
aura branch create <name> [--from <project id|slug|name>] [--org <slug>] [--ttl 72h|3d|2w] [--no-data] [--no-wait] [--json] [--timeout <s>]– Erstellt einen Zweig des verknüpften Projekts (oder von--from), wartet, bis er fertig ist, und gibt dann einmal seine URL und seine API-Schlüssel aus.--ttlgeht von 1h bis 30d (Standard 72h).--no-datakopiert nur das Schemaaura branch list [--from <project>] [--all] [--json]– Listet die Zweige eines Projekts oder der gesamten Organisation mit--allauf; Ausgefallene Zweige bleiben 24 Stunden lang mit ihrem Grund aufgeführtaura branch delete <name> [--from <project>] [--force]– Löscht einen Zweig und seine Datenbank
Datenbank & Migrationen (aura db)
Schemaverwaltung, Synchronisierung, Push/Pull und SQL-Abfragen
aura db push– Gilt für ausstehende lokale SQL-Migrationen (+ Cloud-Synchronisierung, falls verknüpft)aura db pull– Ruft das Remote-Schema ab und aktualisiert das lokale Schemaaura db diff [--name <name>]– Vergleicht das Remote-Schema mit dem lokalen und generiert eine SQL-Migrationaura db status [--json]– Zeigt den detaillierten Status der angewendeten und ausstehenden Migrationen anaura db watch– Überwacht Schemaänderungen und synchronisiert liveaura db reset [--force]– Bereinigen Sie die lokale Datenbank und erstellen Sie sie von Grund auf neu (fragt nach Bestätigung;--forcefür Skripte)aura db seed– Führt das Skript „seed.sql“ aus, um Testdaten zu ladenaura db generate [--lang ts|rust]– Generiert TypeScript (Standard) oder Rust Datenbanktypdefinitionenaura db extensions list [--json]/aura db extensions enable <name>– Listet die installierten Erweiterungen auf oder aktiviert eine zulässige Erweiterungaura db inspect <indexes|tables|locks> [--json]– Indexnutzung (nicht verwendete markiert), Tabellengrößen und tote Zeilen, blockierende Sperrenaura db slow-queries [--limit <n>] [--json]– Listet die langsamsten SQL-Abfragen überpg_stat_statementsaufaura db stats [--json]– Zeigt Verbindungsstatistiken und Datenbank-Festplattennutzung anaura db connection [--new-password] [--yes] [--json]– Direkter PostgreSQL-Zugriff (psql, Prisma, Drizzle,pg_dump): Host, Port, Datenbank und Rolle; mit--new-passwordgibt ein Passwort aus (wird einmal angezeigt, wird nie im Klartext gespeichert, widerruft das vorherige) und gibt die vollständige Verbindungszeichenfolge ausaura db raw "<sql>" [--params <p1> <p2>] [--dry-run] [--read-only] [--json]– Führt eine direkte SQL-Abfrage mit Simulation und schreibgeschützten Optionen ausaura db migration new <name>– Erstellt eine neue SQL-Migrationsdatei mit Zeitstempelaura db migration list [--json]– Listet alle Projektmigrationen und deren Status aufaura db migration down [n]– Bricht die letzten n durchgeführten Migrationen ab (Standard: 1)aura db migration repair <file> [--applied|--reverted]– Markiert eine Migration manuell als angewendet oder abgebrochen im Migrationsverlauf des Projekts (derselbe Verlauf, denaura db statusundmigration listgelesen haben)
RLS Tabellen und Richtlinien (Aura-Datenbanktabelle / -richtlinie)
Deklarative Erstellung, RLS, Echtzeit CDC und Berechtigungen
aura db table list [--json]– Listet die öffentlichen Schematabellen mit ihren Spalten und Typen aufaura db table create <name> "<cols>"– Erstellt eine Tabelle (z. B. „title:text,tags:text[],embedding:vector(1536)“)aura db table drop <name> [-f]– Löscht eine Tabelle und ihre Einschränkungenaura db table rls <name> <on|off>– Aktiviert oder deaktiviert den Sicherheitsschutz auf Zeilenebene für eine Tabelleaura db table realtime <name> <on|off>– Aktiviert oder deaktiviert die Echtzeitveröffentlichung CDC für eine Tabelleaura db policy list [--table <name>] [--all] [--json]– Listet die für Tabellen definierten RLS-Sicherheitsrichtlinien auf (--allenthält interne Speicherregeln)aura db policy add <table> <name> <cmd> [--using-expr <expr>] [--check-expr <expr>]– Erstellt eine neue RLS-Richtlinie (SELECT, INSERT, UPDATE, DELETE oder ALL)aura db policy update <table> <name> [--using-expr <expr>] [--check-expr <expr>]– Ändert die USING / WITH CHECK-Ausdrücke einer Regel ohne Unterbrechungaura db policy delete <table> <name> [-f]– Löscht eine RLS-Sicherheitsregel
Postgres SQL-Funktionen und Trigger (Aura-DB-Funktion/Trigger)
Gespeicherte PL/pgSQL-Prozeduren und Tabellentrigger
aura db function list [--json]– Listet Postgres-Funktionen im Schema auf (Name, Argumente, Sicherheit, Rechte)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>]– Erstellt oder ersetzt eine gespeicherte SQL-Funktion mit strenger Zugriffskontrolleaura db function drop <name> [-f]– Löschen Sie eine Postgres SQL-Funktionaura db trigger list <table> [--json]– Listet alle Trigger in einer Tabelle aufaura db trigger create <table> <name> --function <fn> [--timing before|after|instead_of] --events insert,update [--for-each row|statement]– Bindet eine Triggerfunktion an Tabellenereignisseaura db trigger drop <table> <name> [-f]– Löschen Sie einen Trigger für eine Tabelle
Backups und API-Schlüssel (aura db backup / api-keys)
Snapshots, Wiederherstellung und Verwaltung von Zugriffstokens
aura db backup list [--json]– Listet manuelle und automatisierte Sicherungen der Datenbank aufaura db backup create [--label <label>]– Erstellt einen sofortigen Snapshot der Datenbankaura db backup restore <id> [--verify-only] [--yes]–--yes(oder--force) überspringt die Bestätigung, die in Skripten und CI erforderlich ist; Stellt eine Datenbank aus einem angegebenen Snapshot wieder heraura db backup download <id> [-o <path>]– Laden Sie den vollständigen SQL-Dump eines Backups herunteraura db backup delete <id> [-f]– Löscht ein Sicherungsarchivaura db backup schedule get [--json]– Konsultiert den konfigurierten automatischen Backup-Zeitplanaura db backup schedule set [--frequency hourly|daily|weekly] [--retention-days <n>] [--enable|--disable]– Konfiguriert die Häufigkeit und Aufbewahrungsdauer von Sicherungenaura db apikeys list [--json]– Listet aktive API-Schlüssel auf, die dem Projekt zugeordnet sindaura db apikeys create <name> [--scope anon|authenticated|service_role]– Erzeugt einen neuen API-Schlüssel mit einer bestimmten Rolleaura db apikeys revoke <id> [-f]– Widerruft sofort einen API-Schlüssel
Authentifizierung und Benutzer (Aura Auth)
Verwaltung von Konten, Sitzungen, Audit-Protokollen und E-Mail-Vorlagen
aura auth users list [--json]– Listet die im Projekt registrierten Benutzer aufaura auth users create [--email <email>] [--password <pass>] [--json]– Erstellt einen neuen Benutzer mit Passwort (--jsondruckt den erstellten Benutzer mit seinemidfür Skripte)aura auth users delete <id> [-f]– Einen Benutzer dauerhaft löschenaura auth users ban <id>– Sperrt einen Benutzer und widerruft seine aktiven Sitzungenaura auth users unban <id>– Sperre eines Benutzers aufhebenaura auth sessions list [--json]– Aktive JWT-Sitzungen auflistenaura auth audit-log [--limit 50] [--json]– Sicherheitsüberwachungsprotokolle und Verbindungsversuche anzeigenaura auth settings get [--json]– Zeigt die Authentifizierungskonfiguration an (OAuth, MFA, Zeitüberschreitungen)aura auth settings set KEY=VALUE...– Aktualisiert die Authentifizierungseinstellungenaura auth email-templates list [--json]– E-Mail-Vorlagen auflisten (Bestätigung, Zurücksetzen, magischer Link)aura auth email-templates get <type>– Zeigt den HTML-/Textquellcode einer Vorlage anaura auth email-templates reset <type> [-f]– Setzt eine Vorlage auf die Standardwerte zurück
Kantenfunktionen WASM & Geheimnisse (Aura-Funktionen / Geheimnisse)
Bereitstellen von Edge-Funktionen und verschlüsselten Umgebungsvariablen
aura functions new <name>– Erzeugt das Grundgerüst einer neuen Kantenfunktionaura functions deploy <name>– Kompiliert in die Binärdatei WASM und stellt die Funktion im globalen Netzwerk bereitaura functions list [--json]– Listet lokale und bereitgestellte Funktionen mit ihrem Status aufaura functions logs <name>– Zeigt den Echtzeit-Protokollstream einer Funktion anaura functions serve– Startet den lokalen Testserver für Funktionenaura functions invoke <name> [--data '<json>']– Rufen Sie eine mit einer Nutzlast bereitgestellte Funktion auf und testen Sie sieaura functions download <name>– Laden Sie den Quellcode einer Remote-Funktion herunteraura functions delete <name> [-f]– Löscht eine bereitgestellte Edge-Funktionaura secrets list --function <name> [--json]– Listet geheime Variablen auf, die für eine Funktion konfiguriert sindaura secrets set --function <name> KEY=VALUE...– Definiert verschlüsselte Geheimnisse, die in die Funktion eingefügt werdenaura secrets unset --function <name> KEY...– Entfernt ein oder mehrere Geheimnisse aus einer Funktion
Objektspeicher (Aura-Speicher)
Bucket-Verwaltung und Dateiübertragung
aura storage ls [path]– Listet Buckets oder Dateien in einem Ordner aufaura storage cp <src> <dst>– Dateien übertragen (lokal ↔ Bucket)aura storage rm <path>– Löscht eine in einem Bucket gespeicherte Dateiaura storage mb <name> [--public]– Erstellt einen neuen Bucket (standardmäßig privat oder öffentlich)aura storage buckets list [--json]– Listet alle Speicher-Buckets im Projekt aufaura storage buckets create <name> [--public]– Erstellt einen Speicher-Bucketaura storage buckets delete <name> [-f]– Löscht einen Bucket und bereinigt alle seine Objekte
Lokale Umgebung und Versorgungseinrichtungen
.env-Variablen, TUI-Schnittstelle, automatische Aktualisierung und automatische Vervollständigung
aura env list [--json]– Zeigt Variablen an, die in der lokalen .env definiert sindaura env set KEY=VALUE...– Legt eine oder mehrere Variablen in der lokalen .env festaura env unset KEY...– Variablen aus der lokalen .env-Datei entfernenaura ui– Startet die vollständige interaktive TUI (Terminal User Interface)aura update– Überprüft und aktualisiert die CLI automatisch auf die neueste stabile Versionaura completions <bash|zsh|fish|powershell|elvish>– Erzeugt Autovervollständigungsskripts für Ihre Shell
Interaktive Schnittstelle im Terminal#
Aurabase integriert eine Textmodus-Schnittstelle (aura ui), die von Ratatui unterstützt wird. Sie können damit durch Ihre Datenbanken navigieren, SQL ausführen, Tabellen überprüfen und Protokolle verfolgen, ohne Ihr Terminal zu verlassen.
# Starten Sie die TUI-Oberfläche
aura ui
Globale Optionen und Einstellungen#
--json– Strukturierte JSON-Ausgabe (ideal für Scripting, JQ und CI/CD-Automatisierung)--dry-run– Führt den Befehl in einer Transaktion aus, die am Ende zurückgesetzt wird, um die Einschränkungen zu validieren, ohne die Daten zu ändern--read-only– Sperrt die Transaktion ausschließlich schreibgeschützt auf der Postgres-Engine-f, --force– Ignoriert interaktive Bestätigungsanfragen für destruktive Vorgänge--project-id <uuid>– Zielt auf ein bestimmtes Remote-Projekt ab und ignoriert die lokale Verknüpfungsdatei
Aktivieren Sie die automatische Vervollständigung in Ihrer Shell, um automatisch Tabulatorbefehle auszuführen:aura completions zsh > ~/.zfunc/_aura oder aura completions bash > /etc/bash_completion.d/aura.