SuperAPI AI 工具集

diagram-gen

编程与开发

查看项目

更新于 10-16 07:11

技能介绍

用途

Diagram Generator 用于从代码库自动生成 Mermaid 图表,主要解决架构图因无人维护而总是过时的问题。它通过读取代码来生成准确的 Mermaid 图表,避免手工绘制与后续维护的负担。

主要能力

  • 从代码生成 Mermaid 图表
  • 支持流程图、类图、时序图
  • 可根据数据库 schema 创建 ER 图
  • 输出与 Markdown 兼容的 Mermaid 语法

使用方式

该工具无需安装,直接通过 npx 运行,零配置。基本命令为:

npx ai-diagram ./src/

使用示例:

# 生成流程图
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

工作原理

工具读取源代码文件,理解其结构、关系和数据流,然后生成 Mermaid 语法。生成的语法可在 Markdown 编辑器、GitHub 和文档工具中渲染为图表。

适用场景

  • 新团队成员入职
  • 总是过时的文档
  • 理解不熟悉的代码库
  • 架构评审与规划

最佳实践

  • 选择正确的图表类型:面向对象使用类图,流程使用流程图
  • 聚焦关键模块,不要为所有内容都画图
  • 保持更新:随着代码变化定期运行
  • 加入文档:Mermaid 可在 GitHub Markdown 中渲染

限制与要求

  • 需要 Node.js 18+(推荐)
  • 需要设置 OPENAI_API_KEY 环境变量
  • 无需安装,直接使用 npx 运行

背景

该工具属于 LXGIC Dev Toolkit,是 LXGIC Studios 构建的 110 多个免费开发者工具之一。免费层无付费墙、无需注册、无需 API 密钥。采用 MIT 许可证,永久免费,可随意使用。