treedocs 0.1.0
Initial public release 🎉
treedocs helps people and AI agents understand codebases faster by keeping a concise, version-controlled map of your repository in treedocs.yaml.
Highlights:
- Generate readable tree documentation for files and folders.
- Keep documentation synchronized with the filesystem using
treedocs sync. - Detect stale, missing, or invalid documentation with
treedocs check. - Explore codebases progressively with
treedocs explore. - Search documented paths and descriptions with
treedocs path. - Inspect links, aliases, and subtrees with
treedocs inspectandtreedocs show. - Store structured descriptions, references, and links in a schema-backed
treedocs.yamlfile. - Use the interactive terminal UI to fill in missing descriptions manually, or let AI agents help draft them.
- Validate against the published JSON Schema for editor, CI, and tooling support.
Install note: treedocs is source-build only for now. The package targets macOS 13+, but installing through Homebrew, Mint, or mise requires a Swift 6-capable build environment, usually Xcode 16+. Prebuilt binaries may be added in the future if enough users want them.
Feedback is much appreciated. Let us know how you are using it in the wild.
The best places to find information, updates, and project news are: