GoKawiil✅ The treedocs below is up to date with the filesystem.
Just run treedocs to see the repository at a glance. Current files render green, while stale or invalid entries render red so problems stand out immediately.
Keep documentation from going stale with automatic drift checks that warn or fail. You can even install a Git pre-commit hook so that you never commit undocumented changes.
Give new teammates, future you, and coding agents the concise context they need to understand complex repositories so that they don't need to wander aimlessly.
mise uses its Swift Package Manager backend. treedocs does not currently publish artifact bundles, so mise builds from source. The mise spm: backend is currently experimental, so set MISE_EXPERIMENTAL=true when installing.
treedocs currently supports macOS 13 and newer. Version 0.2.0 is source-build only, so installing through Homebrew, Mint, or mise requires a Swift 6-capable build environment, usually Xcode 16+.
The treedocs.yaml Schema
treedocs.yaml is a version-controlled map of your repository. It mirrors your file tree and stores a human-readable YAML description for every file and folder. This same description can be parsed and displayed with treedocs ' rich tooling. The file format is defined by a canonical JSON Schema, which means editors, CI tools, and AI agents can all parse, validate, and understand the same structure.
Keeping docs up to date is an ongoing task, but treedocs makes it easy! Running treedocs sync updates your treedocs.yaml file, adding new paths and removing ghost paths. All that's left to do is add short descriptions. It's easy to update descriptions with treedocs update .