Skip to main content

​
CLI Commands

​
generate

Generate a new project from a text prompt. 
faces generate --prompt "5-slide pitch deck about AI in healthcare"
Options:
FlagDescription
--prompt <text>(required) Description of the project to generate
--template <id>Use an existing project as a template
--waitWait for the project to finish generating
--api-key <key>API key override
--api-url <url>API URL override
Output: 
{
  "jobId": "cm1abc123...",
  "status": "processing",
  "editorUrl": "https://faces.app/s/xK9mP2qR"
}
Examples: 
# Basic generation
faces generate --prompt "Company intro deck with 3 slides"

# Using a template
faces generate --prompt "Same deck for fintech" --template cm1xyz789

# Wait for completion
faces generate --prompt "Team intro" --wait

​
status

Check the status of a generation job. 
faces status <job-id>
Options:
FlagDescription
--waitPoll until the job completes or fails
--api-key <key>API key override
Examples: 
# Check once
faces status cm1abc123...

# Wait for completion
faces status cm1abc123... --wait

​
list

List your projects. 
faces list
Options:
FlagDescription
--publishedOnly show published projects
--limit <n>Max results (default: 20, max: 100)
--api-key <key>API key override
Examples: 
faces list --published --limit 5
faces list | jq '.projects[].slug'

​
get

Get details of a specific project. 
faces get <slug>
Examples: 
faces get xK9mP2qR
faces get xK9mP2qR | jq '.publishedUrl'

​
login

Sign in and store an API key. 
faces login
Options:
FlagDescription
--api-url <url>Custom API URL
Opens your browser to authenticate, then saves the key to ~/.config/faces/credentials.json.