CLI

La CLI Gheima pilote votre compte depuis le terminal — déployer, suivre les logs, et gérer services, bases de données et stockage. Elle s’authentifie avec une clé API de compte.

Installer et se connecter#

npm install -g @gheima/cli
gheima login

Créez une clé API dans Settings → API keys, puis collez-la à l’invite (elle commence par gh_). La clé est stockée par profil dans ~/.config/gheima/config.json (mode 600). Vous pouvez aussi éviter la connexion en définissant la variable d’environnement GHEIMA_API_KEY.

Options globales#

-k, --key <key>

Clé API pour cet appel (prime sur la variable d’environnement et le profil).

-u, --url <url>

URL de base de l’API (par défaut https://gheima.ma).

-p, --profile <name>

Quel profil stocké utiliser.

--json

Afficher du JSON exploitable plutôt qu’un tableau.

-v, --version

Afficher la version de la CLI.

Commandes du compte#

gheima login

S’authentifier avec une clé API et la stocker dans un profil.

gheima logout

Supprimer un profil stocké.

gheima whoami

Afficher le compte de la clé active (nom, slug, plan, type).

gheima status

Afficher le compte, le plan et le nombre de ressources.

gheima open [resource]

Ouvrir le tableau de bord (ou un chemin) dans le navigateur.

gheima completion [shell]

Imprimer un script de complétion pour bash, zsh ou fish.

Commandes de service#

Les commandes qui prennent un <service> acceptent son id, son nom ou son slug. Les commandes destructrices demandent confirmation sauf si vous passez -y / --yes.

gheima services

Lister les services (alias de services list ; aussi service, svc).

gheima services get <id>

Afficher un service en détail.

gheima services create --name <name> [--project <id>] [--type WEB|WORKER|STATIC] [--repo <url>]

Créer un service (type WEB par défaut ; omettez --project pour le laisser non groupé).

gheima services delete <id> [-y]

Supprimer un service.

gheima deploy [service]

Déclencher un déploiement ; demande le service si omis.

gheima logs <service> [-f] [-b] [-s <text>]

Afficher ou suivre les logs. -f suivre, -b logs de build, -s filtrer.

gheima env pull <service>

Lister les clés de variables avec valeurs masquées.

gheima env set <service> KEY=value

Définir une variable d’environnement.

gheima env rm <service> <key> [-y]

Supprimer une variable d’environnement.

gheima domains <service>

Lister les domaines personnalisés d’un service.

Commandes de ressources#

gheima db

Lister les bases de données (alias databases).

gheima storage buckets

Lister les buckets de stockage objet.

gheima storage ls <bucket> [prefix]

Lister les objets d’un bucket.

gheima storage cp <file> <bucket> [key]

Téléverser un fichier local via une URL présignée.

gheima storage get <bucket> <key> [dest]

Télécharger un objet.

gheima storage rm <bucket> <key> [-y]

Supprimer un objet.

gheima cron

Lister les tâches cron.

gheima webhooks

Lister les webhooks.

gheima services create --name web --type WEB --repo https://github.com/me/app
gheima deploy web
gheima logs web -f -s error
gheima env set web NODE_ENV=production
gheima storage cp ./photo.png my-bucket images/photo.png
gheima services --json | jq '.[].url'