CLI for the Faces AI platform
Project description
faces-cli
Command-line interface for the Faces AI platform.
Install
pip install faces-cli
Requires Python ≥ 3.11.
Quick Start
# Login
faces auth login
# Create a face
faces face create --name "My Bot" --username my-bot
# Chat with it
faces chat chat my-bot --message "Hello!"
# Check your balance
faces billing balance
Authentication
The CLI stores credentials at ~/.faces/config.json.
faces auth login # interactive email + password
faces auth whoami # verify current session
faces auth logout # clear credentials
API key (no login required):
export FACES_API_KEY=sk-proj-...
faces face list
Global Options
faces [--base-url URL] [--token TOKEN] [--api-key KEY] [--json/--no-json] COMMAND
--json(default): JSON output, ideal for piping tojq--no-json: human-readable outputFACES_BASE_URL,FACES_TOKEN,FACES_API_KEYenv vars are respected
Command Groups
| Group | Commands |
|---|---|
auth |
login, logout, register, whoami, refresh |
face |
create, list, get, update, delete, stats, upload |
chat |
chat, messages, responses |
compile |
doc (create/list/get/prepare/sync/delete), thread (create/list/message/sync) |
keys |
create, list, revoke, update (JWT required) |
billing |
balance, subscription, quota, usage, topup, checkout, card-setup |
account |
state |
config |
set, show, clear |
Run faces COMMAND --help for detailed options on any command.
Examples
Face management
faces face create --name "Research Bot" --username research-bot \
--attr "domain=AI research" --attr "language=English"
faces face list | jq '.[].username'
faces face update research-bot --attr "domain=machine learning"
faces face delete research-bot --yes
Inference
# Simple chat
faces chat chat research-bot -m "What are the latest trends in AI?"
# Specify LLM
faces chat chat research-bot --llm gpt-4o -m "Summarize my notes"
# Stream response
faces chat chat research-bot --stream -m "Write a long essay about..."
# Anthropic Messages API
faces chat messages research-bot@claude-sonnet-4-6 -m "Hello"
# OpenAI Responses API
faces chat responses research-bot@gpt-4o -m "Hello"
Compiling to face memory
# Upload a file
faces face upload <face_id> --file report.pdf --kind document
# Or create inline
DOC=$(faces compile doc create <face_id> --label "Notes" --content "Important info...")
DOC_ID=$(echo $DOC | jq -r '.id')
faces compile doc prepare $DOC_ID
faces compile doc sync $DOC_ID --yes
API keys
# JWT login required
faces auth login
faces keys create --name "Partner key" --face my-bot --budget 10 --expires-days 90
faces keys list
faces keys revoke <key_id> --yes
Billing
faces billing balance
faces billing subscription
faces billing quota
faces billing topup --amount 20
faces billing checkout --plan standard
Agent / Claude Code Usage
See SKILL.md for the Claude Code agent skill definition.
License
The faces-cli tool is released under the MIT License.
Note: The MIT license applies solely to this CLI tool. It does not apply to the Faces platform, its API, or any underlying codebase or services operated by Headwaters.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file faces_cli-0.1.0.tar.gz.
File metadata
- Download URL: faces_cli-0.1.0.tar.gz
- Upload date:
- Size: 13.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3942ffba58b1b90993ae68679efdd2d376c9bf4719bfb4d0267f7ee29f7bdefc
|
|
| MD5 |
0a18f951220c3739254420c47b1647e8
|
|
| BLAKE2b-256 |
ab4cc4b18c4dff550c506d988b2f49d9940c5690f98dce5a8f2ab435118f1908
|
File details
Details for the file faces_cli-0.1.0-py3-none-any.whl.
File metadata
- Download URL: faces_cli-0.1.0-py3-none-any.whl
- Upload date:
- Size: 16.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c79b0667ae7f0544e1d1e304237f7c190e96903bd52ce62914dbdd51687c29b5
|
|
| MD5 |
26acf4154013ee4ca8a57afb66e72151
|
|
| BLAKE2b-256 |
03e0e446724fbea0f3dcf56da70c1acaa2494d4da5fa94d2e27c4692b6f7f35e
|