CLI Docs Brief
Published Docusaurus pages for the Hamtrax CLI npm package and hosted CLI API.
Parent: docs-site/docs/DOCS_BRIEF.md.
Files
| File | Purpose |
|---|---|
overview.md | CLI purpose, major capabilities, and quick examples |
install.md | npm install, platform notes, first run, updating, and uninstall |
auth-and-keys.md | API key generation, storage, tiers, rotation, and revocation |
command-reference.md | Hand-authored command and flag reference |
examples.md | Worked CLI workflows |
ai-agent-guide.md | Agent-oriented auth, output, exit-code, and prompt guidance |
security.md | Server-side key storage, audit fields, threat model, and leak handling |
troubleshooting.md | Error recovery, rate limits, and debugging tips |
changelog.md | CLI release history |
Sources Of Truth
| Source | Purpose |
|---|---|
Published npm package hamtrax | CLI package metadata and compiled command behavior |
cloudFunctionsNonClient/src/cli/ | Hosted CLI API routes, auth, rate limits, and server-side key behavior |
src/features/tools/components/HamtraxCliTool/ | In-app key generation, reveal, listing, and revocation UI |
HAMTRAX_CLI_PUBLISH_PLAN.md | CLI extraction and publish runbook |
HAMTRAX_CLI_PARTNER_FORM.md | GitHub Secret Scanning partner packet and endpoint status |