Headroom documentation
Install Headroom, verify your connection, and configure tools for your workflow. Search all articles using the docs navigation.
Getting started
- Quickstart: install, sign in, connect an agent, and verify requests.
- Tutorials and use cases: work with tests, documents, repositories, and library APIs.
- Usage and benefits: understand API costs, subscription usage, and project learnings.
Configuration and reference
- Add-ons: what each tool does, when to use it, and its requirements.
- Project learnings: review saved instructions, scan history, and control auto-learning.
- How savings are measured: input compression, cache reads, and output estimates.
Help and maintenance
- Compatibility: which apps and agents work, which do not, and the workarounds.
- Security: signed releases, verifying a download, what leaves your computer, and reporting a vulnerability.
- Troubleshooting: diagnose routing, setup, learning, and add-on issues.
- For AI agents: installation and diagnostic commands for an agent assisting with setup.
- Changelog: published version notes and downloads.
- Update: how updates arrive on each platform, and how to update the CLI.
- Uninstall: use the in-app uninstall flow to remove managed integrations and local data.
The FAQ covers account, pricing, platform, and privacy questions.
Install Headroom for your operating system.