Diagram Generator(diagram-gen)是一个从代码库自动生成 Mermaid 架构图的开发工具,命令名为 ai-diagram。其核心思路是:架构图往往因为没人维护而过期,而该工具通过读取源代码来生成准确的 Mermaid 图表,从而减少手动绘制与同步的成本。
主要能力
- 从代码生成 Mermaid 图表。
- 支持多种图类型:流程图(flowchart)、类图(class diagram)、序列图(sequence diagram)。
- 可从数据库 schema 生成 ER(实体关系)图。
- 输出与 Markdown 兼容的 Mermaid 语法。
使用方式
工具强调一条命令、零配置,无需安装,直接用 npx 运行。示例如下:
生成流程图: npx ai-diagram ./src/
生成类图并指定输出文件: npx ai-diagram ./src/ --type class -o architecture.mmd
生成函数调用的序列图: npx ai-diagram ./src/ --type sequence
生成实体关系图: npx ai-diagram ./src/ --type er
查看帮助: npx ai-diagram --help
运行要求:推荐 Node.js 18+,需要 OPENAI_API_KEY 环境变量。
工作原理
工具会读取源文件,理解代码的结构、关系与数据流,然后生成可在 Markdown 编辑器、GitHub 和文档工具中渲染的 Mermaid 语法。
最佳实践(文档建议)
- 选择合适的图类型:面向对象用类图,流程用流程图。
- 聚焦关键模块,不必为所有内容作图。
- 随代码变化定期重新运行,保持图表更新。
- 将生成的 Mermaid 加入文档,GitHub Markdown 可直接渲染。
适用场景
- 新团队成员入职。
- 总是过期的文档维护。
- 理解不熟悉的代码库。
- 架构评审与规划。
许可与来源信息
该工具属于 LXGIC Dev Toolkit,是 LXGIC Studios 构建的 110+ 免费开发者工具之一。免费层无付费墙、无需注册、无需 API key(但运行本身需要 OPENAI_API_KEY 环境变量)。采用 MIT 许可证,可永久免费使用。要求、收费或价格等更多细节以官方说明为准;资料未提供的部分暂未提供。