CLI Reference
← Developer Docs · API Reference · Agent skill: phuze-skill.md
[WIP] The CLI is not yet published
@phuze/cli is not on npm yet. The API endpoints that back these commands are all live — the CLI is a convenience wrapper in development. Until it ships, use the curl equivalents on the API Reference page.
Install (coming soon): npm install -g @phuze/cli. Credentials will be stored at ~/.phuze/credentials.json after activation.
Commands
| Command | Does | Backing endpoint |
|---|---|---|
phuze register | Register a new client (interactive — app name, email, domain) | POST /clients |
phuze activate | Complete registration with the emailed code; prints your keys (shown once) | POST /clients/activate |
phuze status | Show client details and current quota usage | GET /clients/me, GET /clients/me/quota |
phuze keys rotate | Rotate your secret_key (old key invalid immediately — update your server env) | POST /clients/me/keys/rotate |
phuze domains list / add / remove | Manage authorized domains (removal rejects that origin immediately) | GET / PATCH /clients/me |
phuze quota | Show current quota usage and limits | GET /clients/me/quota |
phuze keys list / issue / revoke | Manage CLI tokens: list by prefix, issue a new one (shown once — your recovery path), or revoke one (stops working immediately) | GET / POST / DELETE /clients/me/cli-tokens |
phuze dashboard | Open a logged-in dashboard for the current client (one-time link, for your own machine) | POST /clients/me/dashboard-link |
phuze status — example output
Client: Acme Shop (cl_a1b2c3d4e5f6)
Status: active
Plan: free
Domains: shop.acme.com
Quota this period:
Logins today: 3 / 100 (daily quota — see /pricing for your plan)
MAU this month: 12 (not a plan limit — abuse guardrail only)Phuze · phuze.edato.me · Developer Docs · API Reference