Documentation Index¶
Use this page when you want the full document map instead of the quick landing page.
- Getting Started
- installation, first-run setup, login, token generation, open local relay mode, and local serving
- Configuration
- config file shape, environment overrides, and path conventions
- Security
- bearer-token protection, open local relay mode, rate limits, and token rotation
- API Notes
- supported routes, explicit limits, and compatibility behavior
- Architecture
- package layout, request flow, and intentional boundaries
- Subscription Status
- normalized
GET /v1/subscription/statusfields and auth expectations - FAQ
- common usage and policy questions
- Troubleshooting
- auth errors, token failures, rate-limit recovery, and route limitations
- Disclaimer
- independence, non-endorsement, and intended single-user local use
- ADR Index
- durable design decisions and policy records