零安装、代码一键转 Mermaid 流程图。 npx aicode2flow file.go — 支持 8 种语言：Go / Python / JavaScript / TypeScript / Rust / Java / C / C++。

— [English README]

---

快速开始

# 单个文件
npx aicode2flow ./src/main.go

# 扫描整个项目
npx aicode2flow ./src/

把输出的 Mermaid 粘贴到 GitHub Markdown 的 ```mermaid 代码块中，GitHub 会自动渲染。

查看完整使用手册：USAGE_CN.md

---

效果展示

Go

func main() {
    processUser("Alice", "alice@test.com")
}

npx aicode2flow main.go 输出：

flowchart TD
  main(["⭐ main"])
  greet("greet")
  validate("validate")
  processUser("processUser")
  saveUser("saveUser")
  processUser --> greet
  processUser --> validate
  processUser --> saveUser
  main --> processUser

Loading

Python

npx aicode2flow app.py 输出：

flowchart TD
  main(["⭐ main"])
  greet("greet")
  validate("validate")
  process_user("process_user")
  save_user("save_user")
  process_user --> greet
  process_user --> validate
  process_user --> save_user
  main --> process_user

Loading

JavaScript

npx aicode2flow index.js 输出：

flowchart TD
  main(["⭐ main"])
  greet("greet")
  validate("validate")
  processUser("processUser")
  saveUser("saveUser")
  processUser --> greet
  processUser --> validate
  processUser --> saveUser
  main --> processUser

Loading

---

用法

# 基础用法 — 输出 Mermaid 到终端
npx aicode2flow ./src/main.go

# 扫描整个项目（自动识别所有支持的文件）
npx aicode2flow ./

# 扫描项目，只分析 Go 文件
npx aicode2flow ./ --language go

# 保存到文件
npx aicode2flow ./app.py -o flowchart.mmd

# 保存为 Markdown（带 ```mermaid 代码块）
npx aicode2flow ./index.js -o FLOWCHART.md

# 渲染为 SVG（需要 @mermaid-js/mermaid-cli）
npx aicode2flow ./main.go -o diagram.svg
npx aicode2flow ./app.py --format svg -o diagram.svg

# 渲染为 PNG
npx aicode2flow ./index.js --format png -o diagram.png

# 从左到右布局
npx aicode2flow ./main.go --direction LR

# 排除测试文件
npx aicode2flow ./ --exclude "_test|_spec"

# 强制指定语言
npx aicode2flow ./app.py -l go

参数说明

参数	别名	说明	默认值
--output	-o	输出文件路径 (.mmd / .md / .svg / .png)	终端输出
--format	-f	输出格式：mermaid / svg / png	mermaid
--direction		流程图方向：TD（从上到下）、LR（从左到右）	TD
--language	-l	强制指定语言 (go/python/javascript)	自动检测
--depth	-d	分析深度	0
--exclude	-e	排除模式	—
--ai		AI 语义增强（需要 API Key）	false
--theme		Mermaid 主题	default
--version	-v	显示版本
--help	-h	显示帮助

---

支持的语言

语言	状态	扩展名
Go	✅ 已完成	.go
Python	✅ 已完成	.py
JavaScript	✅ 已完成	.js, .jsx, .mjs, .cjs
TypeScript	✅ 已完成	.ts
Rust	✅ 已完成	.rs
Java	✅ 已完成	.java
C	✅ 已完成	.c, .h
C++	✅ 已完成	.cpp, .cxx, .cc, .hpp, .hxx

添加新语言只需要两个文件，不需要改源代码：

1. config/languages/<name>.json — 语言配置
2. queries/<name>.scm — Tree-sitter 查询模式

---

工作原理

源代码 → Tree-sitter AST → 配置驱动的查询引擎 → Mermaid 流程图
                                                       ↓ (可选)
                                                 AI 语义标签

架构采用声明式、元编程设计：

• 语言差异 = 数据（JSON 配置 + SCM 查询），不是代码
• 单分析引擎读取配置即可支持任意语言
• 输出 = 模板渲染，无命令式图构建

---

竞品对比

特性	aicode2flow	code2flow (PyPI)	js2flowchart
零安装 (npx)	✅	❌ pip install	❌ npm install
多语言	✅ Go/Python/JS	✅ Python/JS	❌ 仅 JS
Mermaid 输出	✅ GitHub 原生	❌ Graphviz	❌ 仅 SVG
输出到文件	✅	✅	❌
AI 增强	🚧	❌	❌
持续维护	✅ 活跃	⚠️ 2023 年停更	⚠️ 2022 年停更

---

项目架构

config/languages/          ← JSON：语言定义（数据）
  go.json / python.json / javascript.json

queries/                   ← SCM：AST 查询模式（数据）
  go.scm / python.scm / javascript.scm

src/engine/
  registry.ts              — 读取 JSON 配置 → 语言注册表
  analyzer.ts              — 通用 Tree-sitter 查询引擎
  template.ts              — Mermaid 字符串构建器

src/cli.ts                 — CLI 入口

想加 Rust？config/languages/rust.json + queries/rust.scm 即可，不需要改动一行 TypeScript。

---

开发

git clone https://github.com/peterfei/aicode2flow.git
cd aicode2flow
npm install
npm run build
npm test

---

路线图

• Go / Python / JavaScript 支持
• TypeScript / Rust 支持
• GitHub Action（PR 自动评论流程图）
• SVG/PNG 输出
• Java / C / C++ 支持
• 在线 Playground
• VSCode 插件

---

许可证

MIT