New here? Start with the project README. It covers what this is, why it exists, and how to install it. Then pick a track below.
Using it
- Compatibility: which
gitcommands work through the mount, and how lazily they run. - Limitations: what's deferred or fundamentally constrained, and why.
How it works
- Architecture overview: the moving parts, end to end.
- Worktree model: the read-only baseline plus the durable writable overlay.
- Git state model: what stock git owns vs. what the mount synthesizes.
- FUSE semantics: inodes, file handles, and the implemented operations.
- Object fetching: materialization, single-flight coalescing, filters, and exact size/metadata.
- Index & scalability: the real
.git/index(read-tree HEAD) and scalability notes. - FSMonitor: the durable change journal and the
core.fsmonitorhook. - Startup & deadlock avoidance: the mount startup sequence and the FUSE/git deadlock invariants.
- Durability & security: overlay durability, auth/offline, and the threat model.
Reference
- Specification: the lean, authoritative design the implementation is built and tested against.
- Other platforms: the project is Linux-only. Notes on the Windows (ProjFS) and macOS (FSKit, on-device) backends.