MrLesk/groma.md

它解决的问题

架构图往往在绘制完成的那一刻就过时了。该工具通过创建实时、交互式的软件架构地图来解决“文档过时”的问题，该地图会随着实际代码的变化而保持同步。

工作原理

groma.md 扫描你的仓库以生成基于 C4 的架构地图。它将此地图以纯 Markdown 文件的形式直接存储在 Git 仓库中。由于架构以代码形式存储，你或你的编码代理对地图所做的任何更改都会记录在版本历史中。当你修改源代码时，地图会自动更新以反映新结构，同时保留你的手动整理、描述和组件分组。

适用对象

适用于希望维护准确、最新架构文档而无需手动更新图表的开发者和团队。对于使用 AI 编码代理的用户尤其有用，因为代理可以读取和更新架构文档以及代码。

亮点

• 实时更新： 保存代码时地图自动刷新，确保文档反映当前工作。
• 本地且私有： 该工具完全在本地运行，无需账户，也不会将代码发送到任何外部 AI 服务。
• 版本控制： 由于架构以 Markdown 形式存储在仓库中，你可以在与代码相同的拉取请求中审查架构更改。
• 交互式浏览器地图： 内置 Web 界面允许你缩放查看系统、容器和组件，并直接链接到背后的源代码。
• 可扩展： 通过基于插件的扫描器系统支持多种编程语言。