Habi documentation
New here? Start with Getting started—sample workspace included, takes ~5 minutes.
Habi finds skills that fit your repo, installs them for your agent tools, and carries improvements back to your library. Local, no account or telemetry.
Using Habi#
| Guide |
Read it to |
| Getting started |
Try the sample workspace, open your first project, and know what Habi changes |
| My skills |
Write a skill in the Skill Studio, bring in the ones you have, test where it applies, and use it |
| Sharing |
Send an improved skill to a library as a pull or merge request, follow the review, and revise it |
| Agent tools |
See what Habi writes for Claude Code, Cursor, Codex, Gemini CLI, GitHub Copilot, OpenCode and Junie |
| Recovery |
Restore a change, finish an interrupted one, and free up space |
Writing libraries#
| Guide |
Read it to |
| Habi metadata |
Say when a skill applies with habi.yaml, and describe a library with habi-library.yaml |
| Detectors |
Know what Habi recognizes in a repository, and where that stops |
| Library catalog |
See how the public libraries Habi suggests are chosen, and propose one |
About Habi#
| Document |
Read it to |
| Product contract |
Read the principles Habi keeps, what it is not, and where it is going |
| Security model |
Know what Habi trusts, what it never does, and every network request it makes |
Working on Habi#
| Document |
Read it to |
| Contributing |
Set up, run the checks, and send a change |
| Architecture |
Find your way around the crates and modules, install scopes, data locations, and the UI in a browser |
| Release |
Learn the toolchain, versioning, signing and updates, and follow the release checklist |
| Test data |
Use the fixtures, the sample workspace and the seed script |
| Design |
Keep to the visual direction, the key screens and the accessibility rules |
| Compatibility research |
Check each agent tool's documented paths, and run the smoke tests |
| Reuse assessment |
See which dependencies Habi uses, and why some logic is its own |
| The website |
Build the site, and see how these pages are published on it |
| Decisions |
Read why Habi supports seven agent tools and installs on this machine the way it does |
Documentation map#
| Path |
For |
README.md (root) |
What Habi is & how to build it |
docs/guide/ |
Using Habi—tasks, step-by-step |
docs/library-authors/ |
Writing & curating skill libraries |
docs/project/ |
Product promises, security model |
docs/dev/ |
Habi development (why, not what) |
website/ |
Published docs at acltabontabon.com/habi/docs |