Commands
Every command supports --help for full flag documentation.
Session
| Command | Description |
|---|---|
prxy login [--token=] | Save a session token. v0.1.0 ships token-paste only; the browser flow lands in v0.2.0. |
prxy logout | Wipe the saved session. |
prxy whoami | Show the current logged-in user and active endpoint. |
prxy init | First-run wizard — token paste, optional pipeline preset, optional smoke test. |
prxy doctor | Health check — config, endpoint, token, tier, pipeline. Exit 0 = all green. |
Keys
| Command | Description |
|---|---|
prxy keys list | List active keys (full keys never shown after creation). |
prxy keys create [name] | Mint a new key. Pass --pipeline=<m1>,<m2>,... to set a per-key pipeline. |
prxy keys show <prefix> | Detail view for one key — id, prefix, name, pipeline, created, last-used. |
prxy keys delete <prefix> | Revoke a key. Prompts for confirmation; -y to skip. |
<prefix> accepts the displayed prefix (prxy_abcd1234), the full id, or any
unambiguous prefix substring.
Pipeline
| Command | Description |
|---|---|
prxy pipeline show | Show the active pipeline for your default key (most recently used). Pass --key=<prefix> to choose. |
prxy pipeline set <pipe> | Set a per-key pipeline override. Comma-separated, or default to clear. |
prxy pipeline test <pipe> | Preview a pipeline without saving (uses x-prxy-pipe header). |
Usage
| Command | Description |
|---|---|
prxy usage today | Today’s totals + by-model breakdown. |
prxy usage month | Current calendar month. |
prxy usage by-model | Last 30 days grouped by model. |
Billing
| Command | Description |
|---|---|
prxy billing balance | Credits, tier, period end, auto-recharge state. |
prxy billing portal | Open the Stripe Customer Portal in your browser. --print outputs the URL instead. |
prxy billing upgrade --tier=pro | Open Stripe Checkout for pro or team. |
In LOCAL_MODE, billing returns a synthetic free-tier response — useful for local-only deployments that re-use the dashboard UI.
Modules
| Command | Description |
|---|---|
prxy modules list | Browse the public module registry. Filter with --category=<cat> or --verified. |
prxy modules search <q> | Substring + tag match across name, displayName, description. |
prxy modules info <name> | Full detail for one module — author, version, repo, npm, docs. |
Reads from the same index.json the marketplace site uses. Override the URL
with PRXY_REGISTRY_URL=https://... (mirrors / staging registries).
Misc
| Command | Description |
|---|---|
prxy send "<prompt>" | One-off /v1/messages call. --model=, --max-tokens=, --system=, --pipe=, --json. |
prxy bench | Run the local benchmark suite (shells out to pnpm --filter @prxy/benchmarks bench). |
prxy bench --remote | Live benchmark against your authenticated cloud endpoint. -n <count> for request count. |
Exit codes
| Code | Meaning |
|---|---|
| 0 | success |
| 1 | generic error |
| 2 | not authenticated |
| 3 | network unreachable |
| 4 | server returned 5xx |
| 64 | usage error (bad flags / args) |
These follow POSIX-ish conventions so they work cleanly in shell scripts and CI.
Last updated on