Skip to content
Reference /CLI

Reference

Page 5 of 6

CLI

Control Charon from a terminal or a script with the charon command.

1 section · 2 min read

The charon command does from a terminal what the app does on screen. It comes with the app; link it onto your path once:

Terminal
sudo ln -sf /Applications/Charon.app/Contents/Resources/charon /usr/local/bin/charon

It finds Charon through charon.toml and admin.token. Every command takes --json for scripts, --url <url> (or CHARON_URL) to reach another address, and --config-dir <dir> to read another config folder.

Command What it does
charon status Health, hardware, backends, GPU instances and spend
charon start | stop Start Charon in the background (--no-wait), or stop it
charon reload Re-read charon.toml and policy.yaml
charon models Aliases and models on every backend
charon models catalog Models to download; ★ marks the best fit
charon models pull <id | url> Download and add a model (--sha256 for URLs, --id, --context-length)
charon models load | unload | rm <id> Load, unload, or remove a local model (rm keeps the file)
charon backend add <kind> … Add a backend (kinds and options below)
charon backend list | test | remove <name> List backends, send a test request, or remove one
charon backend start | stop <name> [--wait] Start or stop an EC2 GPU instance
charon policy apply <file> Check and apply a policy (mistakes show file:line:column)
charon policy show Print the active policy
charon logs [-f] [-n N] Recent routing decisions; -f follows new ones
charon request <id> Every option weighed for one request, with scores
charon keys create <name> [--tag local-only] Create a client key (shown once)
charon keys list | revoke <id> List or revoke client keys
charon spend [--period day | month] Estimated cloud spend per backend
charon settings [key=value …] Show or change settings, such as pause_cloud=true
charon bench ttft --model auto Time to first token (--runs, --max-tokens)

charon backend add

Kinds: openai, ollama, llama-server, openai_compat, bedrock, ec2, azure, vertex, mock. Options: --name, --base-url, --model (repeatable), --key-from-keychain, --key-env, --local, --region, --profile, --auth, --project, --instance-id, --port, --scheme, --tunnel, --hourly-usd, --idle-stop-minutes and --stop-on-exit. Backends shows which kind uses which, and charon backend add --help describes each.

↑↓to move↵to open