Skip to content
Back to search

oh-my-mermaid

MarketplaceWorks with Claude CodeGitHub

Turn complex codebases into clear, navigable architecture diagrams with Claude Code.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/oh-my-mermaid-oh-my-mermaid/badge.svg)](/listings/oh-my-mermaid-oh-my-mermaid)

HTML

<a href="/listings/oh-my-mermaid-oh-my-mermaid"><img src="/api/listings/oh-my-mermaid-oh-my-mermaid/badge.svg" alt="findsafeskills safety rating" /></a>

Install

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Paste this in your terminal:

npm install -g oh-my-mermaid && omm setup

Then open your AI coding tool and use the `/omm-scan` skill:

/omm-scan

That's it. View the result:

omm view

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

.claude-plugin/marketplace.json · Manifest · 16 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. {
  2. "name": "oh-my-mermaid",
  3. "owner": {
  4. "name": "oh-my-mermaid"
  5. },
  6. "plugins": [
  7. {
  8. "name": "oh-my-mermaid",
  9. "description": "Turn complex codebases into clear, navigable architecture diagrams with Mermaid",
  10. "version": "0.2.0",
  11. "source": "./",
  12. "category": "development",
  13. "homepage": "https://github.com/oh-my-mermaid/oh-my-mermaid"
  14. }
  15. ]
  16. }
README.md · README · 137 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. [English](./README.md) | [Türkçe](./README.tr.md) | [한국어](./README.ko.md) | [日本語](./README.ja.md) | [中文](./README.zh.md)
  2. <p align="center">
  3. <img src="./docs/logo.jpg" alt="omm logo" width="80"/>
  4. </p>
  5. <h1 align="center">Oh-my-mermaid</h1>
  6. <p align="center">
  7. <a href="https://www.npmjs.com/package/oh-my-mermaid"><img src="https://img.shields.io/npm/v/oh-my-mermaid" alt="npm version"/></a>
  8. <a href="./LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"/></a>
  9. </p>
  10. <p align="center">
  11. AI writes code in seconds. Humans understand it in hours.<br/>
  12. But skip understanding, the codebase becomes a black box — even to you.<br/><br/>
  13. <strong>omm closes the gap — architecture docs, generated by AI, for humans.</strong>
  14. </p>
  15. ---
  16. ## Quick Start
  17. Paste this in your terminal:
  18. ```bash
  19. npm install -g oh-my-mermaid && omm setup
  20. ```
  21. Then open your AI coding tool and use the `/omm-scan` skill:
  22. ```
  23. /omm-scan
  24. ```
  25. That's it. View the result:
  26. ```bash
  27. omm view
  28. ```
  29. ## Example
  30. > omm scanned itself. This is what it found.
  31. <table><tr>
  32. <td width="50%"><img src="./docs/screenshot.png" alt="omm viewer"/></td>
  33. <td width="50%"><img src="./docs/demo.gif" alt="omm scan demo"/></td>
  34. </tr></table>
  35. ## How It Works
  36. Your AI analyzes the codebase and generates **perspectives** — different lenses on your architecture (structure, data flow, integrations...). Each perspective contains a Mermaid diagram and documentation fields.
  37. Every node gets **recursively analyzed**. Complex nodes become nested child elements with their own diagrams. Simple ones stay as leaves. The filesystem reflects the tree:
  38. ```
  39. .omm/
  40. ├── overall-architecture/ ← perspective
  41. │ ├── description.md
  42. │ ├── diagram.mmd
  43. │ ├── context.md
  44. │ ├── main-process/ ← nested element
  45. │ │ ├── description.md
  46. │ │ ├── diagram.mmd
  47. │ │ └── auth-service/ ← deeper nesting
  48. │ │ └── ...
  49. │ └── renderer/
  50. │ └── ...
  51. ├── data-flow/
  52. └── external-integrations/
  53. ```
  54. The viewer auto-detects nesting from the filesystem — elements with children render as expandable groups, others as nodes.
  55. Each element carries up to 7 fields: `description`, `diagram`, `context`, `constraint`, `concern`, `todo`, `note`.
  56. ## CLI
  57. ```bash
  58. omm setup # Register skills with your AI tools
  59. omm view # Open interactive viewer
  60. omm config language ko # Set content language
  61. omm update # Update to latest version
  62. ```
  63. Run `omm help` for the full command list.
  64. ## Skills
  65. Skills are commands you run **inside your AI coding tool** (not the terminal). They start with `/`.
  66. | Skill | What it does |
  67. | --- | --- |
  68. | `/omm-scan` | Analyze codebase → generate architecture docs |
  69. | `/omm-push` | Login + link + push to cloud in one step |
  70. ## Cloud
  71. You can store your architecture in the cloud via [ohmymermaid.com](https://ohmymermaid.com).
  72. ```bash
  73. omm login && omm link && omm push
  74. ```
  75. It's private by default. Share with your team, or make it public like [this example](https://ohmymermaid.com/share/c47e20a7063c231760361ed9cb9ec4b6).
  76. ## Supported AI Tools
  77. | Platform | Setup |
  78. | --- | --- |
  79. | Claude Code | `omm setup claude` |
  80. | Codex | `omm setup codex` |
  81. | Cursor | `omm setup cursor` |
  82. | OpenClaw | `omm setup openclaw` |
  83. | Antigravity | `omm setup antigravity` |
  84. Run `omm setup` to auto-detect and configure all installed tools.
  85. ## Roadmap
  86. See [docs/ROADMAP.md](./docs/ROADMAP.md).
  87. ## Development & Contributing
  88. ```bash
  89. git clone https://github.com/oh-my-mermaid/oh-my-mermaid.git
  90. cd oh-my-mermaid
  91. npm install && npm run build
  92. npm test
  93. ```
  94. Issues and PRs welcome. Use [Conventional Commits](https://www.conventionalcommits.org/).
  95. ## License
  96. [MIT](./LICENSE)

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.