Start here
This handbook is written in Hanji, kept in Hanji's repository, and read through the product itself. 🎉
Quick start
Five minutes from a repo full of Markdown to a place worth reading:
git clone https://github.com/gethanji/hanji && cd hanji && pnpm install
pnpm dev:web # → http://localhost:4100
First visit, a short welcome takes it from there: your name for the place, your password, your first folder of Markdown.
The full walk, with what each line does for you: Quick start.
Set up yours
Four shapes Hanji is lived in. Start with the one that matches you.
| You are | Start here |
|---|---|
| Just you, on your machine | Quick start - the five minutes above, explained |
| A team on a tailnet | On your tailnet - one shared instance, and nobody types a password |
| Working with coding agents | Agents - scoped reads, and their edits arrive as proposals you review |
| Publishing docs to the world | Publish to the web - one command; this site is the proof |
The documentation
How to use it, and how it actually works. Written to serve you mid-task.
| Page | What it does for you |
|---|---|
| Install Hanji | From clone to a running instance, with the rough edges named. |
| Mounts | Point Hanji at your repositories, and keep them in sync on their own. |
| Reading and writing | The daily feel: reading, editing, search, history, organizing. |
| Proposals | Review what agents and teammates propose - diff, Merge, done. |
| Command reference | Every CLI command in one table, for when you know what you want. |
| Permissions | The lock, from mount to single page - and exactly what it enforces. |
| The two faces | The human front and the agent surface, over one git. |
| Byte-fidelity | Why a one-word edit is a one-line diff, forever. |
| Performance | Paper-thin: the speed and size numbers. |
| Features | The whole list, with honest status. |
The story
The why. What makes this more than a wiki - The story opens with the manifesto and carries the rest: the name, the difference, the fit, the mission, the principles, the brand.
Deeper still: how it's built (How it's built · The serializer · The core · The editor · The MCP server · The web front), contributing (Contributing · Developing · Conventions · Open core), the brand (The brand · The visual language · Voice), and the project (Principles · Where we are · Changelog).