Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://docs.faces.app/llms.txt

Use this file to discover all available pages before exploring further.

Le CLI Faces vous permet de générer des présentations interactives et explorables depuis votre terminal. Décrivez ce que vous voulez et obtenez un projet partageable et en direct en quelques secondes.

Installation

npm install -g @facesapp/cli
Cela installe la commande faces dans votre $PATH.

Authentification

Exécutez la commande de connexion pour créer et enregistrer une clé API :
faces login
Cette commande va :
  1. Ouvrir votre navigateur pour vous connecter à Faces
  2. Créer une clé API nommée « CLI »
  3. L’enregistrer dans ~/.config/faces/credentials.json (mode 0600)
Par défaut, la clé est associée à votre équipe personnelle. Pour utiliser une équipe partagée à la place, passez --team avec le slug ou l’id de l’équipe :
faces login --team acme
Toute commande CLI exécutée avec cette clé fonctionnera sous l’équipe choisie. Les nouveaux projets y sont créés, et faces list affiche les projets de cette équipe (ainsi que ceux partagés avec vous). Vous pouvez trouver le slug ou l’id d’une équipe via l’API : GET /api/v1/teams.
Vous pouvez aussi passer une clé API directement avec --api-key ou définir la variable d’environnement FACES_API_KEY. Les clés créées depuis Settings > Developers dans le tableau de bord vous permettent de choisir une équipe au moment de la création, comme alternative à faces login --team.

Vérification

faces list
Si l’authentification fonctionne, vous verrez vos projets (ou une liste vide).

Configuration

Le CLI lit la configuration dans cet ordre :
  1. Le flag --api-key (priorité la plus élevée)
  2. ~/.config/faces/credentials.json (créé par login)
  3. La variable d’environnement FACES_API_KEY
# Avec les variables d'environnement
export FACES_API_KEY="faces_your_key_here"
faces list

# Avec les flags
faces list --api-key faces_your_key_here