OUTILLAGE — LIGNE DE COMMANDE

Vos bases Postgres, pilotées depuis le terminal.

La CLI lampion couvre l'intégralité de l'API : projets, branches, endpoints, SQL, rôles, extensions, backups, anonymisation. Output formaté avec Rich pour l'humain, sortie JSON pour l'automatisation.

pip install lampion-cli · v0.2.1 · PyPI · Python 3.10+

Pour les agents IA, voir le serveur MCP. Pour le détail des endpoints, la référence API.

bashpremier contact
# installer, configurer le token, lister
$ pip install lampion-cli
$ export LAMPION_TOKEN=lmp_live_…
$ lampion projects list
→ my-app · fr-par-1 · running
§ 01 — INSTALLATION

Installer et configurer

Un paquet PyPI, aucune dépendance système. Exportez une clé API scopée et la CLI parle à l'API de production.

pip
pip install lampion-cli — Python 3.10+, aucune dépendance native.
uv
uv pip install lampion-cli — même paquet, resolver ultra-rapide.
LAMPION_TOKEN
clé API scopée (lmp_live_…) exportée en variable d’environnement.
LAMPION_API_URL
optionnel — pointe par défaut sur api.lampion.cloud.
shellinstall & auth
# installer depuis PyPI
$ pip install lampion-cli
$ uv pip install lampion-cli
# exporter la clé API scopée
$ export LAMPION_TOKEN=lmp_live_xxxxxxxxxxxxxxxx
# (optionnel) cibler une autre API
$ export LAMPION_API_URL=https://api.lampion.cloud

Générez une clé API dans Settings › API Keys de la console.

§ 02 — DÉMARRAGE

De zéro à une requête SQL

Créez un projet, récupérez le connection string, exécutez du SQL, forkez une branch pour tester — le tout sans quitter le terminal.

terminalworkflow complet
# créer un projet sur Scaleway Paris
$ lampion projects create my-app --region fr-par-1
✓ Project created: abc123 (fr-par-1)

# lister les endpoints pour le connection string
$ lampion endpoints list abc123
┌──────────┬─────────┬──────────────────────────────────────────┐
│ ID       │ Status  │ Connection String                         │
├──────────┼─────────┼──────────────────────────────────────────┤
│ ep-abc   │ running │ postgresql://cloud_admin:[email protected]…  │
└──────────┴─────────┴──────────────────────────────────────────┘

# exécuter du SQL
$ lampion sql abc123 ep-abc "SELECT count(*) FROM users"
┌─────────┐
│ count   │
├─────────┤
│ 42,847  │
└─────────┘

# créer une branch, tester, supprimer
$ lampion branches create abc123 staging --parent abc123 --ttl 24
✓ Branch created: stg-tid (staging)
  Expires after 24 h.
$ lampion branches delete abc123 stg-tid
✓ Deleted
§ 03 — COMMANDES

La surface complète, en un écran

Chaque commande de la CLI, regroupée par domaine. Toutes suivent la même forme : lampion <groupe> <action> <arguments>.

projects 4
lampion projects list Lister les projets
lampion projects create my-app --region fr-par-1 Créer un projet
lampion projects get <id> Détails d'un projet
lampion projects delete <id> Supprimer un projet
branches 6
lampion branches list <pid> Lister les branches
lampion branches create <pid> dev --parent <pid> --ttl 24 Créer une branch CoW (--ttl : suppression auto)
lampion branches reset <pid> <bid> Reset au parent
lampion branches merge <pid> <bid> --dry-run Merger le schéma (preview)
lampion branches promote <pid> <bid> Promouvoir en main
lampion branches delete <pid> <bid> Supprimer une branch
endpoints 4
lampion endpoints list <pid> Lister les computes
lampion endpoints get <pid> <eid> Détails d'un endpoint
lampion endpoints suspend <pid> <eid> Scale to zero
lampion endpoints resume <pid> <eid> Relancer
sql & schema 2
lampion sql <pid> <eid> "SELECT ..." Exécuter du SQL
lampion schema <pid> --database postgres Introspecter le schéma
databases & roles 6
lampion databases list <pid> <eid> Lister les databases
lampion databases create <pid> <eid> mydb Créer une database
lampion databases drop <pid> <eid> mydb Supprimer une database
lampion roles list <pid> <eid> Lister les rôles
lampion roles create <pid> <eid> app_user Créer un rôle
lampion roles drop <pid> <eid> app_user Supprimer un rôle
extensions 3
lampion extensions list <pid> <eid> Lister
lampion extensions install <pid> <eid> pgvector Installer
lampion extensions uninstall <pid> <eid> pgvector Désinstaller
monitoring 4
lampion metrics <pid> CPU, RAM, connexions, cache
lampion slow-queries <pid> <eid> Top requêtes lentes
lampion logs <pid> <eid> --lines 50 Tail des logs PG
lampion usage <pid> Usage compute/storage
backups 3
lampion backups list <pid> Lister les snapshots
lampion backups create <pid> <bid> "name" Créer un snapshot
lampion backups restore <pid> <bkid> Restaurer
dump 2
lampion dump <pid> <eid> --format custom -o db.dump Export pg_dump (--format sql, custom ou csv)
lampion export <pid> <eid> Export complet en .tar.gz : rôles sans mots de passe, un pg_dump par base, empreintes SHA-256
anon (PII masking) 5
lampion anon status <pid> <bid> Statut anonymisation
lampion anon enable <pid> <bid> Activer le masking
lampion anon add-rule <pid> <bid> --table users --column email --function "anon.fake_email()" Ajouter une règle
lampion anon remove-rule <pid> <bid> <rule-id> Retirer une règle
lampion anon disable <pid> <bid> Désactiver
sécurité 5
lampion allowlist get <pid> <eid> IP allowlist
lampion allowlist set <pid> <eid> 1.2.3.4/32 Configurer l'allowlist
lampion permissions list <pid> <eid> Permissions par rôle
lampion permissions grant <pid> <eid> --role app --table users --privilege SELECT GRANT
lampion permissions revoke <pid> <eid> --role app --table users --privilege SELECT REVOKE
conformité 7
lampion residency <pid> Localisation des données
lampion compliance questionnaire --format md -o security.md Base de réponses aux questionnaires sécurité (md, csv, json)
lampion compliance residency --pdf residency.pdf Rapport de résidence de l'organisation (JSON ou PDF horodaté)
lampion compliance dpa Statut du DPA (accord de traitement RGPD)
lampion compliance dpa-accept --company "ACME SAS" --signer "Jane Doe" --title CTO Accepter le DPA au nom de l'entreprise (owner)
lampion compliance dpa-certificate --pdf dpa.pdf Certificat d'acceptation du DPA (PDF)
lampion compliance subprocessors Sous-traitants RGPD utilisés par votre organisation
§ 04 — AUTOMATISATION

Human-readable ou pipe-able

Par défaut, l'output est formaté avec Rich pour la lecture. Ajoutez --json aux commandes list et aux create (projets, branches, rôles) : la sortie devient parsable par jq, un script ou un pipeline CI/CD.

--json
Sort uniquement le JSON brut renvoyé par l'API sur stdout, sans couleur, bordure ni retour à la ligne — idéal en pipe.
jq
Chaînez avec jq pour extraire des champs ou filtrer les résultats.
LAMPION_TOKEN
Aucune interaction : le token en env suffit pour scripter en CI.
shelljson + jq
# sortie JSON brute
$ lampion projects list --json
[{"id":"abc123","name":"my-app","region":"fr-par-1"}]

# extraire un champ avec jq
$ lampion projects list --json | jq '.[].id'
"abc123"

# créer une branch éphémère et récupérer son id
$ lampion branches create abc123 ci --parent abc123 --ttl 4 --json | jq -r .id
ci-tid
RÉGIONS · FR
DONNÉES SOUVERAINES
PARIS — FR-PAR
§ 05 — RÉGIONS

Où vivent vos données

Passez --region à la création d'un projet. Infrastructure Scaleway à Paris — les données de vos bases ne quittent jamais le territoire ; d'autres régions souveraines sont sur la roadmap.

Région Opérateur Localisation
fr-par-1 Scaleway Paris — Vitry-sur-Seine
fr-gra-1 OVH Cloud Gravelines — GRA (roadmap)
Scaleway, à Paris (hébergeur certifié ISO/IEC 27001 et HDS ; Lampion ne l’est pas). Aucune donnée de vos bases hors de France. Portabilité multi-cloud sur la roadmap.

Un terminal, toute
la plateforme.

Créer un compte Voir sur GitHub pip install lampion-cli — sans carte bancaire.