Aller au contenu
Logo Aurabase
aurabase

Aura CLI — Référence complète

Le binaire officiel aura vous permet de contrôler l'ensemble de la plateforme Aurabase : développement local, Kubernetes, migrations SQL, fonctions stockées, Edge Functions WASM, RLS, Stockage et Auth.

Référence12 min de lectureNiveau référenceRévisé le 19 août 2026

Cette page a été traduite automatiquement. La version anglaise fait foi.

Un binaire autonome, disponible partout#

La CLI est un binaire Rust autonome. Il est installé aujourd'hui par NPM sur macOS Apple Silicon, et par compilation à partir de sources partout ailleurs. Les packages 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.

terminalbash
# 1. NPM — macOS Apple Silicon uniquement à partir d'aujourd'hui
npm install -g @aurabase/cli
aura --help

# 2. Depuis la source — toutes les plateformes (Rust 1.7x+)
git clone https://github.com/Aurabase-cloud/Aurabase.git
cargo install --path Aurabase/aura-cli
#    installez le binaire `aurabase` dans ~/.cargo/bin
aurabase --help

Authentifier la CLI#

Vous pouvez vous connecter avec votre compte console ou en utilisant un jeton d'accès personnel pour vos pipelines CI/CD :

terminalbash
# Connexion interactive (ouvre le navigateur)
aura login

# Connexion non interactive (email/mot de passe)
aura login --email dev@example.com --password "secret"

# Connexion via jeton d'accès personnel (idéal pour les actions GitHub / GitLab CI)
aura login --token aura_pat_9a8b7c6d5e4f...

# Compte chèque et projet actif
aura whoami

Référence exhaustive par module#

Recherchez toutes les commandes et sous-commandes prises en charge par le binaire aura :

Montage et gestion de projet

Initialisation, connexion et diagnostic du projet

  • aura init — Initialise un nouveau projet Aurabase (structure, config, docker)
  • aura login [--email <email>] [--password <pass>] [--token <pat>] — Se connecte au compte de console ou avec un jeton d'accès personnel
  • aura register [--email <email>] [--password <pass>] — Crée un nouveau compte de développeur de console Aurabase
  • aura logout — Déconnecte la session locale active
  • aura whoami — Affiche l'utilisateur connecté, son organisation et le projet actif
  • aura link --project-id <uuid> — Lie le répertoire actuel à un projet cloud existant
  • aura status — Affiche l'état du projet, la connexion et l'état du service
  • aura doctor — Diagnostique l'environnement local (Docker, ports, outils système)

Développement local

Gestion de la stack locale (Kubernetes / k3d) et logs

  • aura start — Démarre tous les microservices locaux Aurabase sur k3d
  • aura stop — Arrête le cluster k3d et les services locaux
  • aura restart — Redémarre les services locaux
  • aura dev — Mode de développement continu : surveille les migrations et synchronise les types
  • aura studio — Ouvre l'interface locale de Studio dans votre navigateur (localhost:3000)
  • aura logs [-s <service>] [--since 1h] [--tail 100] — Affiche les journaux unifiés ou filtrés par service (aura-auth, aura-db, gateway...)
  • aura connect — Ouvre un terminal psql interactif sur le point de terminaison PostgreSQL direct du projet (psql demande le mot de passe émis par aura db connection --new-password)

Organisations et projets cloud

Gestion multi-tenant des organisations et des projets

  • aura orgs list [--json] — Répertorie 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] — Répertorie 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 retry <id> — Réexécute le provisionnement d'un projet dans error et imprime son URL et ses clés une fois qu'il est prêt
  • aura projects graphql-enable <id> [--wait] — Active l'extension GraphQL (pg_graphql) sur le projet
  • aura projects graphql-config <id> [--introspection on|off] [--max-rows N] [--inflect-names on|off] [--wait] — Affiche ou modifie les paramètres pg_graphql (sans indicateur, imprime les paramètres en vigueur)

Branches de base de données (branche aura)

Une branche est un nouveau projet cloné à partir d'un projet PostgreSQL, avec sa propre URL et ses propres clés, supprimé à la fin de sa durée de vie. Voir les branches de base de données pour connaître les limites et ce qui est cloné.

  • aura branch create <name> [--from <project id|slug|name>] [--org <slug>] [--ttl 72h|3d|2w] [--no-data] [--no-wait] [--json] [--timeout <s>] — Crée une branche du projet lié (ou de --from), attend qu'elle soit prête, puis imprime une fois son URL et ses clés API. --ttl passe de 1h à 30j (72h par défaut). --no-data copie uniquement le schéma
  • aura branch list [--from <project>] [--all] [--json] — Liste les branches d'un projet, ou de l'ensemble de l'organisation avec --all; les branches en échec restent répertoriées pendant 24 heures avec leur raison
  • aura branch delete <name> [--from <project>] [--force] — Supprime une branche et sa base de données

Base de données et migrations (aura db)

Gestion des schémas, synchronisation, push/pull et requêtes SQL

  • aura db push — S'applique aux migrations SQL locales en attente (+ synchronisation cloud si liée)
  • aura db pull — Ré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 schéma local et génère une migration SQL
  • aura db status [--json] — Affiche l'état détaillé des migrations appliquées et en attente
  • aura db watch — Surveille les modifications du schéma et les synchronise en direct
  • aura db reset [--force] — Purger et recréer la base de données locale à partir de zéro (demande une confirmation ; --force pour les scripts)
  • aura db seed — Exécute le script seed.sql pour charger les données de test
  • aura db generate [--lang ts|rust] — Génère des définitions de type de base de données TypeScript (par défaut) ou Rust
  • aura db extensions list [--json] / aura db extensions enable <name> — Répertorie les extensions installées ou en active une autorisée
  • aura db inspect <indexes|tables|locks> [--json] — Utilisation de l'index (ceux inutilisés signalés), tailles de table et lignes mortes, blocage des verrous
  • aura db slow-queries [--limit <n>] [--json] — Répertorie les requêtes SQL les plus lentes via pg_stat_statements
  • aura db stats [--json] — Affiche les statistiques de connexion et l'utilisation du disque de la base de données
  • aura db connection [--new-password] [--yes] [--json] — Accès direct PostgreSQL (psql, Prisma, Drizzle, pg_dump) : hôte, port, base de données et rôle ; avec --new-password, émet un mot de passe (affiché une fois, jamais stocké en clair, révoque le précédent) et imprime la chaîne de connexion complète
  • aura db raw "<sql>" [--params <p1> <p2>] [--dry-run] [--read-only] [--json] — Exécute une requête SQL directe avec des options de simulation et de lecture seule
  • aura db migration new <name> — Crée un nouveau fichier de migration SQL horodaté
  • aura db migration list [--json] : répertorie toutes les migrations de projets et leur statut
  • aura db migration down [n] — Annule les n dernières migrations appliquées (par défaut : 1)
  • aura db migration repair <file> [--applied|--reverted] — Marque manuellement une migration comme appliquée ou annulée dans l'historique de migration du projet (le même historique aura db status et migration list lu)

Tables et politiques RLS (table/politique de base de données aura)

Création déclarative, RLS, CDC en temps réel et autorisations

  • aura db table list [--json] — Répertorie les tables de schéma publiques avec leurs colonnes et types
  • aura db table create <name> "<cols>" — Crée un tableau (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 de sécurité au niveau des lignes sur une table
  • aura db table realtime <name> <on|off> — Active ou désactive la publication CDC en temps réel sur une table
  • aura db policy list [--table <name>] [--all] [--json] — Répertorie les politiques de sécurité RLS définies sur les tables (--all inclut les règles de stockage internes)
  • aura db policy add <table> <name> <cmd> [--using-expr <expr>] [--check-expr <expr>] — Crée une nouvelle stratégie RLS (SELECT, INSERT, UPDATE, DELETE ou ALL)
  • aura db policy update <table> <name> [--using-expr <expr>] [--check-expr <expr>] — Modifie les expressions USING / WITH CHECK d'une règle sans la rompre
  • aura db policy delete <table> <name> [-f] — Supprime une règle de sécurité RLS

Postgres Fonctions et déclencheurs SQL (fonction/déclencheur aura db)

Procédures stockées PL/pgSQL et déclencheurs de table

  • aura db function list [--json] — Répertorie les fonctions Postgres dans le 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 un contrôle d'accès strict
  • aura db function drop <name> [-f] — Supprimer une fonction SQL Postgres
  • aura db trigger list <table> [--json] — Répertorie tous les déclencheurs dans un tableau
  • aura db trigger create <table> <name> --function <fn> [--timing before|after|instead_of] --events insert,update [--for-each row|statement] — Lie une fonction de déclenchement aux événements de la table
  • aura db trigger drop <table> <name> [-f] — Supprimer un déclencheur sur une table

Sauvegardes et clés API (sauvegarde aura db / clés API)

Snapshots, restauration et gestion des jetons d'accès

  • aura db backup list [--json] — Répertorie les sauvegardes manuelles et automatisées de la base de données
  • aura db backup create [--label <label>] — Génère un instantané immédiat de la base de données
  • aura db backup restore <id> [--verify-only] [--yes] — --yes (ou --force) ignore la confirmation requise dans les scripts et CI ; Restaure une base de données à partir d'un instantané spécifié
  • aura db backup download <id> [-o <path>] — Téléchargez le dump SQL complet d'une sauvegarde
  • 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 conservation des sauvegardes
  • aura db apikeys list [--json] — Répertorie 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 spécifique
  • aura db apikeys revoke <id> [-f] — Révoque immédiatement une clé API

Authentification et utilisateurs (aura auth)

Gestion des comptes, sessions, journaux d'audit et modèles d'e-mails

  • aura auth users list [--json] — Répertorie les utilisateurs enregistrés dans le projet
  • aura auth users create [--email <email>] [--password <pass>] [--json] — Crée un nouvel utilisateur avec mot de passe (--json imprime l'utilisateur créé, avec son id, pour les scripts)
  • aura auth users delete <id> [-f] — Supprimer définitivement un utilisateur
  • aura auth users ban <id> – Bannit un utilisateur et révoque ses sessions actives
  • aura auth users unban <id> — Annuler le bannissement d'un utilisateur
  • aura auth sessions list [--json] — Liste les sessions JWT actives
  • aura auth audit-log [--limit 50] [--json] — Afficher les journaux d'audit de sécurité et les tentatives de connexion
  • aura auth settings get [--json] — Affiche la configuration d'authentification (OAuth, MFA, délais d'attente)
  • aura auth settings set KEY=VALUE... — Met à jour les paramètres d'authentification
  • aura auth email-templates list [--json] — Liste des modèles d'e-mails (confirmation, réinitialisation, lien magique)
  • aura auth email-templates get <type> — Affiche le code source HTML/texte d'un modèle
  • aura auth email-templates reset <type> [-f] — Réinitialise un modèle aux valeurs par défaut

Fonctions Edge WASM et secrets (fonctions aura / secrets)

Déploiement de fonctionnalités Edge et de variables d'environnement chiffrées

  • aura functions new <name> — Génère le squelette d'une nouvelle fonction Edge
  • aura functions deploy <name> — Compile en binaire WASM et déploie la fonction sur le réseau mondial
  • aura functions list [--json] — Répertorie les fonctions locales et déployées avec leur statut
  • aura functions logs <name> — Affiche le flux de journal en temps réel d'une fonction
  • aura functions serve — Démarre le serveur de test local pour les fonctions
  • aura functions invoke <name> [--data '<json>'] — Invoquer et tester une fonction déployée avec une charge utile
  • aura functions download <name> — Télécharger le code source d'une fonction distante
  • aura functions delete <name> [-f] — Supprime une fonction Edge déployée
  • aura secrets list --function <name> [--json] — Répertorie les variables secrètes configurées pour une fonction
  • aura secrets set --function <name> KEY=VALUE... — Définit les 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 (stockage aura)

Gestion des compartiments et transfert de fichiers

  • aura storage ls [path] — Répertorie les compartiments ou les fichiers dans un dossier
  • aura storage cp <src> <dst> — Transférer 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] — Répertorie tous les compartiments de stockage du projet
  • aura storage buckets create <name> [--public] — Crée un bucket de stockage
  • aura storage buckets delete <name> [-f] — Supprime un compartiment et purge tous ses objets

Environnement local et services publics

Variables .env, interface TUI, mise à jour automatique et complétion automatique

  • 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... — Supprimer les variables du fichier .env local
  • aura ui — Lance la TUI (Terminal User Interface) entièrement interactive
  • aura update — Vérifie et met automatiquement à jour la CLI vers la dernière version stable
  • aura completions <bash|zsh|fish|powershell|elvish> — Génère des scripts d'auto-complétion pour votre shell

Interface interactive dans le terminal#

Aurabase intègre une interface en mode texte (aura ui) optimisée par Ratatui. Il vous permet de naviguer dans vos bases de données, d'exécuter du SQL, d'inspecter les tables et de suivre les journaux sans quitter votre terminal.

terminalbash
# Lancez l'interface TUI
aura ui

Options et paramètres globaux#

  • --json — Sortie JSON structurée (idéale pour les scripts, l'automatisation jq et 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 stricte lecture seule sur le moteur Postgres
  • -f, --force — Ignore les demandes de confirmation interactives pour les opérations destructrices
  • --project-id <uuid> — Cible un projet distant spécifique, en ignorant le fichier de liaison local
Astuce

Activez la saisie semi-automatique dans votre shell pour tabuler automatiquement les commandes :
aura completions zsh > ~/.zfunc/_aura ou aura completions bash > /etc/bash_completion.d/aura.

Pour aller plus loin#