大家好，我是讯享网，很高兴认识大家。这里提供最前沿的Ai技术和互联网信息。



GitHub 地址：https://github.com/oh-my-mermaid/oh-my-mermaid

Oh My Mermaid (omm)​ 是一个基于 Claude Code​ 生态的代码架构可视化与文档生成工具。它解决了“代码写得快，但后人（包括未来的自己）看不懂”的工程痛点。

传统的架构图是“死的”——画完就过时。Oh My Mermaid 反其道而行：直接让 AI（Claude）分析你的源码，自动生成 Mermaid 架构图，并构建一个可交互的、与代码结构严格对应的文档树。它不仅是画图工具，更是将“代码理解”工程化的 CLI + Skill 套件。

1. AI 驱动的多视角架构扫描

• 智能透视：通过 /omm-scanSkill，Claude Code 会像资深架构师一样遍历你的代码，生成结构（Structure）、数据流（Data Flow）、集成（Integrations）​ 等多个维度的“视角（Perspectives）”。
• 递归解析：支持无限层级嵌套。对于复杂的模块（如 auth-service），AI 会递归地为其生成子图，确保大项目的细节不被折叠。

2. 文件系统即文档树（FSDT）

• 自动映射：生成的文档不是单个文件，而是一棵完整的目录树（.omm/）。目录代表“组件”，文件代表“属性”（描述、图、上下文等）。
• 智能渲染：omm view命令能自动识别这棵树，将目录渲染为可折叠的组件组，将文件渲染为详情节点，实现“所见即所得”的导航。

3. 七字段结构化文档

每个架构节点（无论是顶层视角还是底层类）都包含最多 7 个标准字段，让文档超越“画图”：

• Diagram：核心的 Mermaid 流程图/类图。
• Description & Context：功能描述与业务上下文。
• Constraint & Concern：技术约束与潜在风险点（Tech Debt）。
• Todo & Note：待办事项与自由备注。

4. 云端同步与团队协作

• 私有云存储：通过 omm login和 omm push，将架构文档同步到私有的 ohmymermaid.com 空间。
• 权限控制：默认私有，可分享给团队成员或公开示例（如官方 Demo），无需暴露源代码即可共享架构设计。

环境要求

• Node.js：18 或以上版本。
• AI 工具：必须安装 Claude Code（npm install -g @anthropic-ai/claude-code）或其他支持技能的工具（Cursor、Codex 等）。

一键安装与配置

1. 全局安装：

   npm install -g oh-my-mermaid

2. 自动配置：

   运行 omm setup，它会自动检测你本地安装的 AI 工具（Claude Code、Cursor 等），并注册 /omm-scan等技能。

   （也可单独指定：omm setup claude）

3. 验证：在终端输入 omm，看到帮助菜单即表示安装成功。

工作流：从代码到架构图只需 3 步

1. 扫描：在 Claude Code 会话中，输入 /omm-scan。AI 会自动分析当前项目，在 .omm/目录生成完整的架构文档树。
2. 查看：在终端运行 omm view，会自动打开浏览器，呈现一个可交互的架构导航界面。
3. 迭代：代码变更后，重新运行 /omm-scan，文档会自动更新，保持与代码同步。

关键命令速查

• omm setup：配置 AI 工具技能（首次安装后运行一次）。
• omm view：启动本地 Web 服务器查看架构图。
• omm config language ko：设置文档生成语言（如韩语）。
• omm push：将本地文档推送到云端（需先 omm login）。

场景一：接手“屎山”遗产代码库

痛点：新入职或接手一个没有文档、结构混乱的旧项目，git clone后面对数千个文件无从下手。

Oh My Mermaid 方案：

1. 进入项目根目录，在 Claude Code 中运行 /omm-scan。
2. 结果：AI 会自动识别出“上帝类”、“循环依赖”和“数据流转黑洞”，并生成 data-flow和 structure图。
3. 价值：你无需阅读一行代码，通过 omm view的交互图就能在 30 分钟内理清核心业务流程和模块边界，快速定位需要优先重构的“肿瘤模块”。

场景二：团队架构评审（Architecture Review）

痛点：团队设计评审时，PPT 架构图是“理想版”，代码是“现实版”，两者脱节，讨论经常陷入“你以为 vs 我以为”的无效争论。

Oh My Mermaid 方案：

1. 在 PR 合并前，运行 /omm-scan生成当前版本的“真实架构图”。
2. 将生成的 .omm/目录或云端链接附在 PR 描述中。
3. 价值：评审者基于同一份由代码生成的真相进行讨论，能精准发现设计偏离（如“说好的微服务，怎么在图上变成了单体耦合？”），杜绝“架构漂移”。

场景三：外挂式技术债务管理

痛点：代码中散落着 // TODO: Refactor this注释，但缺乏统一管理，容易被遗忘。

Oh My Mermaid 方案：

1. AI 在扫描时，会自动将代码中的坏味道（如过长的函数、紧密的耦合）识别为 Concern（风险点）或 Todo（待办项）。
2. 这些内容被结构化地记录在 .omm/树中对应的节点下。
3. 价值：你可以通过 omm view的“Concern”视图，全局查看所有技术债务的分布和严重程度，为下一个迭代周期的重构计划提供数据支撑，而非依赖开发者的记忆。

Oh My Mermaid 的本质是将“代码理解”这一高智力活动，通过 AI + 标准化 Schema，变成了可重复、可自动化的工程流程。它生成的不是一张会过时的静态图片，而是一个与代码同生共死的“活文档系统”。

对于个人开发者，它是理解复杂依赖的“X 光机”；对于团队，它是统一架构认知的“事实标准”。它让文档重新变得可信，因为它的源头是代码本身。

GitHub 地址：https://github.com/oh-my-mermaid/oh-my-mermaid