Aurabase Logo
aurabasedocs
docs›Référence›CLI

CLI aura — Référence complète

Le binaire officiel aura permet de piloter l'intégralité de la plateforme Aurabase : dev local, Docker Compose, migrations SQL, fonctions stockées, Edge Functions WASM, RLS, Storage et Auth.

Référence12 min de lecture·Niveau référence·Révisé le 19 août 2026
#
Installation

Un binaire autonome, disponible partout

Le CLI est un binaire Rust autonome. Il s'installe aujourd'hui par NPM sur macOS Apple Silicon, et par compilation depuis les sources partout ailleurs. Les paquets de binaires précompilés pour Linux, macOS Intel et Windows ne sont pas encore publiés : npm install -g @aurabase/cli y échoue, ce n'est pas une erreur de votre part.

terminal
BASH
# 1. NPM — macOS Apple Silicon uniquement à ce jour
npm install -g @aurabase/cli
aura --help
# 2. Depuis les sources — toutes plateformes (Rust 1.7x+)
git clone https://github.com/daylami/aurabase.git
cargo install --path aurabase/aura-cli
#    installe le binaire `aurabase` dans ~/.cargo/bin
aurabase --help
#
Connexion

Authentifier le CLI

Vous pouvez vous connecter avec votre compte console ou en utilisant un Personal Access Token pour vos pipelines CI/CD :

terminal
BASH
# Connexion interactive (ouvre le navigateur)
aura login
# Connexion non interactive (email / mot de passe)
aura login --email dev@example.com --password "secret"
# Connexion via Personal Access Token (idéal pour GitHub Actions / GitLab CI)
aura login --token aura_pat_9a8b7c6d5e4f...
# Vérifier le compte et le projet actif
aura whoami
#
Commandes

Référence exhaustive par module

Retrouvez l'ensemble des commandes et sous-commandes supportées par le binaire aura :

Project Setup & Gestion
Initialisation, connexion et diagnostic du projet
aura initInitialise un nouveau projet Aurabase (structure, config, docker)
aura login [--email <email>] [--password <pass>] [--token <pat>]Se connecte au compte console ou avec un Personal Access Token
aura register [--email <email>] [--password <pass>]Crée un nouveau compte développeur Aurabase Console
aura logoutDéconnecte la session locale active
aura whoamiAffiche l'utilisateur connecté, son organisation et le projet actif
aura link --project-id <uuid>Lie le répertoire courant à un projet cloud existant
aura statusAffiche le statut du projet, la connexion et l'état des services
aura doctorDiagnostique l'environnement local (Docker, ports, outils système)
Développement Local
Gestion du stack local Docker Compose et logs
aura startDémarre l'ensemble des microservices locaux Aurabase via Docker
aura stopArrête tous les conteneurs et services locaux
aura restartRedémarre les conteneurs locaux
aura devMode dev continu : surveille les migrations et synchronise les types
aura studioOuvre l'interface Studio locale dans votre navigateur (localhost:3000)
aura logs [-s <service>] [--since 1h] [--tail 100]Affiche les logs unifiés ou filtrés par service (aura-auth, aura-db, gateway...)
aura connectOuvre un terminal interactif psql directement connecté à la base
Organisations & Projets Cloud
Pilotage multi-tenant des organisations et projets
aura orgs list [--json]Liste les organisations dont vous êtes membre
aura orgs create --name <name> --slug <slug>Crée une nouvelle organisation Cloud
aura orgs use <slug>Définit l'organisation par défaut pour les commandes
aura projects list [--org <slug>] [--json]Liste les projets d'une organisation
aura projects create <name> [--engine postgres|mongodb] [--org <slug>]Provisionne un nouveau projet
aura projects delete <id>Supprime définitivement un projet et ses données
aura projects api-keys [--project-id <id>]Affiche les clés API du projet (anon, service_role)
aura projects rename <id> <name>Renomme un projet existant
aura projects graphql-enable <id>Active l'extension GraphQL (pg_graphql) sur le projet
Base de données & Migrations (aura db)
Gestion du schéma, synchronisation, push/pull et requêtes SQL
aura db pushApplique les migrations SQL locales en attente (+ synchro cloud si lié)
aura db pullRécupère le schéma distant et met à jour le schéma local
aura db diff [--name <name>]Compare le schéma distant avec le local et génère la migration SQL
aura db status [--json]Affiche l'état détaillé des migrations appliquées et en attente
aura db watchSurveille les modifications de schéma et synchronise en direct
aura db resetPurger et recréer la base de données locale depuis zéro
aura db seedExécute le script seed.sql pour charger des données de test
aura db generateGénère les définitions de types TypeScript Database
aura db raw "<sql>" [--params <p1> <p2>] [--dry-run] [--read-only] [--json]Exécute une requête SQL directe avec options de simulation et lecture seule
aura db migration new <name>Crée un nouveau fichier de migration SQL horodaté
aura db migration list [--json]Liste toutes les migrations du projet et leur statut
aura db migration down [n]Annule les n dernières migrations appliquées (défaut : 1)
aura db migration repair <file> [--applied|--reverted]Marque manuellement une migration comme appliquée ou annulée
Tables & Politiques RLS (aura db table / policy)
Création déclarative, RLS, CDC temps réel et permissions
aura db table list [--json]Liste les tables du schéma public avec leurs colonnes et types
aura db table create <name> "<cols>"Crée une table (ex: "title:text,tags:text[],embedding:vector(1536)")
aura db table drop <name> [-f]Supprime une table et ses contraintes
aura db table rls <name> <on|off>Active ou désactive la protection Row Level Security sur une table
aura db table realtime <name> <on|off>Active ou désactive la publication Realtime CDC sur une table
aura db policy list [--table <name>] [--json]Liste les politiques de sécurité RLS définies sur les tables
aura db policy add <table> <name> <cmd> [--using-expr <expr>] [--check-expr <expr>]Crée une nouvelle politique RLS (SELECT, INSERT, UPDATE, DELETE ou ALL)
aura db policy update <name> <table> [--using-expr <expr>] [--check-expr <expr>]Modifie les expressions USING / WITH CHECK d'une règle sans coupure
aura db policy delete <name> <table> [-f]Supprime une règle de sécurité RLS
Fonctions SQL & Triggers Postgres (aura db function / trigger)
Procédures stockées PL/pgSQL et déclencheurs de table
aura db function list [--json]Liste les fonctions Postgres du schéma (nom, arguments, sécurité, droits)
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>]Crée ou remplace une fonction SQL stockée avec contrôle d'accès strict
aura db function drop <name> [-f]Supprime une fonction SQL Postgres
aura db trigger list <table> [--json]Liste tous les déclencheurs (triggers) d'une table
aura db trigger create <table> <name> --function <fn> [--timing before|after|instead_of] --events insert,update [--for-each row|statement]Lie une fonction trigger à des événements de table
aura db trigger drop <table> <name> [-f]Supprime un trigger sur une table
Sauvegardes & Clés API (aura db backup / apikeys)
Snapshots, restauration et gestion des tokens d'accès
aura db backup list [--json]Liste les sauvegardes manuelles et automatisées de la base
aura db backup create [--label <label>]Génère un snapshot immédiat de la base de données
aura db backup restore <id> [--verify-only]Restaure une base à partir d'un snapshot spécifié
aura db backup download <id> [-o <path>]Télécharge le dump SQL complet d'un backup
aura db backup delete <id> [-f]Supprime une archive de sauvegarde
aura db backup schedule get [--json]Consulte le planning de sauvegarde automatique configuré
aura db backup schedule set [--frequency hourly|daily|weekly] [--retention-days <n>] [--enable|--disable]Configure la fréquence et la durée de rétention des backups
aura db apikeys list [--json]Liste les clés API actives associées au projet
aura db apikeys create <name> [--scope anon|authenticated|service_role]Génère une nouvelle clé API avec un rôle précis
aura db apikeys revoke <id> [-f]Révoque immédiatement une clé API
Authentification & Utilisateurs (aura auth)
Gestion des comptes, sessions, logs d'audit et templates d'email
aura auth users list [--json]Liste les utilisateurs enregistrés dans le projet
aura auth users create [--email <email>] [--password <pass>]Crée un nouvel utilisateur avec mot de passe
aura auth users delete <id> [-f]Supprime définitivement un utilisateur
aura auth users ban <id>Bannit un utilisateur et révoque ses sessions actives
aura auth users unban <id>Lève le bannissement d'un utilisateur
aura auth sessions list [--json]Liste les sessions JWT actives
aura auth audit-log [--limit 50] [--json]Consulte les logs d'audit de sécurité et tentatives de connexion
aura auth settings get [--json]Affiche la configuration auth (OAuth, MFA, timeouts)
aura auth settings set KEY=VALUE...Met à jour les paramètres d'authentification
aura auth email-templates list [--json]Liste les templates d'email (confirmation, reset, magic link)
aura auth email-templates get <type>Affiche le code source HTML/texte d'un template
aura auth email-templates reset <type> [-f]Réinitialise un template aux valeurs par défaut
Edge Functions WASM & Secrets (aura functions / secrets)
Déploiement de fonctions Edge et variables d'environnement chiffrées
aura functions new <name>Génère le squelette d'une nouvelle Edge Function
aura functions deploy <name>Compile en binaire WASM et déploie la fonction sur le réseau mondial
aura functions list [--json]Liste les fonctions locales et déployées avec leur statut
aura functions logs <name>Affiche le flux de logs en temps réel d'une fonction
aura functions serveDémarre le serveur local de test pour les fonctions
aura functions invoke <name> [--data '<json>']Invoque et teste une fonction déployée avec un payload
aura functions download <name>Télécharge le code source d'une fonction distante
aura functions delete <name> [-f]Supprime une Edge Function déployée
aura secrets list --function <name> [--json]Liste les variables secrètes configurées pour une fonction
aura secrets set --function <name> KEY=VALUE...Définit des secrets chiffrés injectés dans la fonction
aura secrets unset --function <name> KEY...Supprime un ou plusieurs secrets d'une fonction
Stockage d'objets (aura storage)
Gestion des buckets et transfert de fichiers
aura storage ls [path]Liste les buckets ou les fichiers d'un dossier
aura storage cp <src> <dst>Transfère des fichiers (local ↔ bucket)
aura storage rm <path>Supprime un fichier stocké dans un bucket
aura storage mb <name> [--public]Crée un nouveau bucket (privé par défaut, ou public)
aura storage buckets list [--json]Liste tous les buckets de stockage du projet
aura storage buckets create <name> [--public]Crée un bucket de stockage
aura storage buckets delete <name> [-f]Supprime un bucket et purge l'ensemble de ses objets
Environnement Local & Utilitaires
Variables .env, interface TUI, auto-update et auto-complétion
aura env list [--json]Affiche les variables définies dans le .env local
aura env set KEY=VALUE...Définit une ou plusieurs variables dans le .env local
aura env unset KEY...Supprime des variables du fichier .env local
aura uiLance l'interface interactive TUI (Terminal User Interface) complète
aura updateVérifie et met à jour automatiquement la CLI vers la dernière version stable
aura completions <bash|zsh|fish|powershell|elvish>Génère les scripts d'auto-complétion pour votre shell
#
TUI

Interface interactive dans le terminal

Aurabase intègre une interface en mode texte (aura ui) propulsée par Ratatui. Elle permet de naviguer dans vos bases, exécuter du SQL, inspecter les tables et suivre les logs sans quitter votre terminal.

terminal
BASH
# Lancer l'interface TUI
aura ui
#
Flags

Options et paramètres globaux

  • --json — Sortie structurée JSON (idéal pour le scripting, jq et l'automatisation CI/CD)
  • --dry-run — Exécute la commande dans une transaction annulée à la fin pour valider les contraintes sans modifier les données
  • --read-only — Verrouille la transaction en lecture seule stricte au niveau du moteur Postgres
  • -f, --force — Ignore les demandes de confirmation interactives pour les opérations destructives
  • --project-id <uuid> — Cible un projet distant spécifique en ignorant le fichier local de liaison
Astuce
Activez l'auto-complétion dans votre shell pour tabuler automatiquement les commandes :
aura completions zsh > ~/.zfunc/_aura ou aura completions bash > /etc/bash_completion.d/aura.
Dernière mise à jour · 19 août 2026