Swift CLI 通过为每个文件和文件夹提供文档化树状结构，快速理解任何代码库。 treedocs 演示视频 可读树输出 只需运行 treedocs 即可一目了然地查看存储库。 当前文件呈绿色，而过时或无效条目呈红色，从而使问题立即显而易见。 ✅ 以下 treedocs 与文件系统保持同步。 . ├── README.md 用户界面概述、安装和命令使用文档。 ├── Sources/ treedocs 可执行文件的 Swift 包源代码。 │ └── treedocs/ 主要的 treedocs 可执行目标。 │ ├── Commands/ treedocs 子命令的 ArgumentParser 命令实现。 │ └── Core/ 加载、扫描、渲染和更新 treedocs 数据的核心服务。 ├── site/ 部署到项目 GitHub Pages 网站的静态文件。 │ ├── index.html treedocs GitHub Pages 网站的登录页面。 │ └── styles.css treedocs GitHub Pages 登录页面的样式表。 └── old-file.swift 过时条目：磁盘上没有匹配的路径。 更快地适应 为新团队成员、未来的你和编程人员提供他们理解复杂存储库所需的简洁上下文，以便他们不必漫无目的地游荡。 保持更新 通过自动漂移检查防止文档过时，并发出警告或失败。 您甚至可以安装 Git 预提交钩子，以确保您永远不会提交未记录的更改。 以上下文进行审查 将简单、可读的、版本控制的摘要存储在 treedocs.yaml 中，以便审查更轻松，代理花费更少的令牌重新发现项目结构。 安装 treedocs 目前支持 macOS 13 及更高版本。 版本 0.2.0 仅支持源构建，因此通过 Homebrew、Mint 或 mise 安装需要一个支持 Swift 6 的构建环境，通常是 Xcode 16 以上。 mise MISE_EXPERIMENTAL=true mise use -g spm:DandyLyons/treedocs@0.2.0 mise 使用其 Swift 包管理器后端。 treedocs 目前不发布工件包，因此 mise 从源代码构建。 mise spm: 后端目前处于实验阶段，因此在安装时请设置 MISE_EXPERIMENTAL=true。 Homebrew brew install DandyLyons/tap/treedocs Homebrew 配方通过 DandyLyons tap 从源构建 treedocs。 Mint mint install DandyLyons/treedocs@0.2.0 mint run DandyLyons/treedocs@0.2.0 --help Mint 根据标记的 GitHub 源构建 Swift 可执行包。 快速开始 treedocs init # 创建一个 treedocs.yaml 文件 treedocs sync # 将 treedocs.yaml 与您当前的文件夹结构同步并检查错误。 treedocs show . # 显示文档树 treedocs check # 检查 treedocs.yaml 中的错误。 treedocs explore . # 逐步披露代码库的探索。 非常适合代理探索。 treedocs.yaml 模式 treedocs.yaml 是您存储库的版本控制映射。 它反映您的文件树，并为每个文件和文件夹存储可读的 YAML 描述。 这个描述可以与 treedocs 的丰富工具一起解析和显示。 文件格式由规范 JSON 架构定义，这意味着编辑器、CI 工具和AI代理都可以解析、验证并理解相同的结构。 保持文档最新是一个持续的任务，但 treedocs 使其变得简单！ 运行 treedocs sync 会更新您的 treedocs.yaml 文件，添加新路径并删除无效路径。 剩下的就是添加短描述。 使用 treedocs update . 更新描述很简单。 或者干脆请一个代理为您填写 treedocs.yaml 文件。 代理在填写描述方面非常出色，并且所有内容都可以通过 treedocs check 进行验证。