Documentation
Hypnos documentation
Three guides, one per reader: the person using the desktop app, the one writing a client, and the one running a server. The README on GitHub is the introduction; backend/hypnos.example.toml documents every option.
Desktop manual
How to install the app, let it set itself up, chat with attachments, voice and images, choose models, and what every panel shows.
For everyone who uses the app.
API reference
Every route with its request and response fields, the streaming formats, the error shape and the telemetry on each response.
For client and SDK authors.
Operating guide
Sizing a machine, which knob to turn for which symptom, reading the telemetry and the errors, logs, exposure, upgrades, running it as a service.
For whoever runs a server.
More on GitHub
- README: what Hypnos is, the model lineup, the endpoint table and the quickstart.
- hypnos.example.toml: the reference config, every option with a comment.
- desktop/README.md: the desktop app for developers: building it, how it reaches the server, the bundled server.
- docs/apple-silicon.md: unified memory, Metal's working set, the design record for the Mac.
- docs/signing.md: signing and notarizing the macOS and Windows builds.
- docs/bench: the measured runs on CUDA and Apple Silicon.
- sdk/: the Python, JavaScript and Rust clients.
- CHANGELOG.md: what each release changed.