您是否难以理解AI编写代码的总体情况? 👀
哦,我的美人鱼,⭐️大约2600。一个人分析代码并创建一个用于配置图+解释的OSS。
您可以做什么👇
结构和数据流的美人鱼图
挖掘分层结构以识别复杂零件
-使用图表组织限制和问题
与Claude Code/Codex/Cursor等兼容。
减少“它的工作原理,但我不知道它是如何工作的。”
用于理解和移交AI开发代码。
https://github.com/oh-my-mermaid/oh-my-mermaid
oh-my-mermaid(简称 omm)是一个面向 AI 编程时代的开源架构文档生成工具,由 AI 自动分析代码库并输出 Mermaid 图表与配套说明。它的核心思路是:AI 几秒钟就能写出代码,人类却要花几小时才能读懂,如果跳过理解这一步,代码库就会变成连你自己都看不懂的黑盒。omm 正是为填补这道鸿沟而生,通过 npm 全局安装后运行 omm setup,再在 Claude Code、Codex、Cursor 等 AI 编程工具中执行 /omm-scan 技能,即可生成结构、数据流、外部集成等多视角架构文档,并用 omm view 打开交互式查看器浏览结果。
用 AI 写代码的人大多有过这种体验:功能跑通了,但整个项目是怎么串起来的、数据从哪流到哪、模块之间如何依赖,心里完全没底。代码量越大,这种失控感越强,接手别人 AI 生成的代码更是无从下手。传统做法是手动画架构图、写注释文档,既费时又容易和代码脱节,最后文档烂尾、图过期,团队交接时只能靠口头描述,效率极低。
omm 把架构理解这件事交给 AI 完成,从扫描、生成到查看形成一条完整链路,并支持把结果推送到云端共享。
自动产出结构、数据流、外部集成等不同视角的 Mermaid 图表与说明文档。
复杂模块会被继续下钻分析,生成嵌套子元素与独立图表,简单节点保持叶子状态。
omm view 按文件系统自动识别嵌套层级,带子元素的节点渲染为可展开分组。
通过 omm login、link、push 把架构文档存到云端,默认私有,也可分享给团队。
它切中的是 AI 编程普及后越来越普遍的理解断层问题,用自动化文档替代手工维护,让架构知识能跟着代码一起沉淀下来。
支持 Claude Code、Codex、Cursor、OpenClaw、Antigravity,一条命令自动配置。
每个元素最多携带描述、图表、约束、待办等七个字段,便于持续补充与交接。
项目已在 GitHub 开源,采用 MIT 协议,可通过 oh-my-mermaid 仓库 了解安装与使用细节。
您是否难以理解AI编写代码的总体情况? 👀
哦,我的美人鱼,⭐️大约2600。一个人分析代码并创建一个用于配置图+解释的OSS。
您可以做什么👇
结构和数据流的美人鱼图
挖掘分层结构以识别复杂零件
-使用图表组织限制和问题
与Claude Code/Codex/Cursor等兼容。
减少“它的工作原理,但我不知道它是如何工作的。”
用于理解和移交AI开发代码。
https://github.com/oh-my-mermaid/oh-my-mermaid