Skip to main content
The Faces CLI lets you generate interactive, explorable decks from your terminal. Describe what you want and get a live, shareable project in seconds.

​
Install

This installs the faces command on your $PATH.

​
Authenticate

Run the login command to create and store an API key:
This will:
  1. Open your browser to sign in to Faces
  2. Create an API key named “CLI”
  3. Save it to ~/.config/faces/credentials.json (mode 0600)
By default the key is scoped to your personal team. To use a shared team instead, pass --team with the team slug or id:
Every CLI command run with that key will operate under the chosen team: new projects are created there, and faces list shows projects from that team (plus any shared with you). You can find a team’s slug or id by running faces teams list (or via the API: GET /api/v1/teams).
You can also pass an API key directly with --api-key or set the FACES_API_KEY environment variable. Keys created from Settings > Developers in the dashboard let you pick a team at creation time as an alternative to faces login --team.

​
Verify

If authentication is working, you’ll see your projects (or an empty list).

​
Configuration

The CLI reads configuration in this order:
  1. --api-key flag (highest priority)
  2. ~/.config/faces/credentials.json (created by login)
  3. FACES_API_KEY environment variable