oh-my-mermaid
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.
Badge for your README
Markdown
[](/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)
- {
- "name": "oh-my-mermaid",
- "owner": {
- "name": "oh-my-mermaid"
- },
- "plugins": [
- {
- "name": "oh-my-mermaid",
- "description": "Turn complex codebases into clear, navigable architecture diagrams with Mermaid",
- "version": "0.2.0",
- "source": "./",
- "category": "development",
- "homepage": "https://github.com/oh-my-mermaid/oh-my-mermaid"
- }
- ]
- }
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)
- [English](./README.md) | [Türkçe](./README.tr.md) | [한국어](./README.ko.md) | [日本語](./README.ja.md) | [中文](./README.zh.md)
- <p align="center">
- <img src="./docs/logo.jpg" alt="omm logo" width="80"/>
- </p>
- <h1 align="center">Oh-my-mermaid</h1>
- <p align="center">
- <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>
- <a href="./LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"/></a>
- </p>
- <p align="center">
- AI writes code in seconds. Humans understand it in hours.<br/>
- But skip understanding, the codebase becomes a black box — even to you.<br/><br/>
- <strong>omm closes the gap — architecture docs, generated by AI, for humans.</strong>
- </p>
- ---
- ## Quick Start
- Paste this in your terminal:
- ```bash
- 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:
- ```bash
- omm view
- ```
- ## Example
- > omm scanned itself. This is what it found.
- <table><tr>
- <td width="50%"><img src="./docs/screenshot.png" alt="omm viewer"/></td>
- <td width="50%"><img src="./docs/demo.gif" alt="omm scan demo"/></td>
- </tr></table>
- ## How It Works
- 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.
- 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:
- ```
- .omm/
- ├── overall-architecture/ ← perspective
- │ ├── description.md
- │ ├── diagram.mmd
- │ ├── context.md
- │ ├── main-process/ ← nested element
- │ │ ├── description.md
- │ │ ├── diagram.mmd
- │ │ └── auth-service/ ← deeper nesting
- │ │ └── ...
- │ └── renderer/
- │ └── ...
- ├── data-flow/
- └── external-integrations/
- ```
- The viewer auto-detects nesting from the filesystem — elements with children render as expandable groups, others as nodes.
- Each element carries up to 7 fields: `description`, `diagram`, `context`, `constraint`, `concern`, `todo`, `note`.
- ## CLI
- ```bash
- omm setup # Register skills with your AI tools
- omm view # Open interactive viewer
- omm config language ko # Set content language
- omm update # Update to latest version
- ```
- Run `omm help` for the full command list.
- ## Skills
- Skills are commands you run **inside your AI coding tool** (not the terminal). They start with `/`.
- | Skill | What it does |
- | --- | --- |
- | `/omm-scan` | Analyze codebase → generate architecture docs |
- | `/omm-push` | Login + link + push to cloud in one step |
- ## Cloud
- You can store your architecture in the cloud via [ohmymermaid.com](https://ohmymermaid.com).
- ```bash
- omm login && omm link && omm push
- ```
- It's private by default. Share with your team, or make it public like [this example](https://ohmymermaid.com/share/c47e20a7063c231760361ed9cb9ec4b6).
- ## Supported AI Tools
- | Platform | Setup |
- | --- | --- |
- | Claude Code | `omm setup claude` |
- | Codex | `omm setup codex` |
- | Cursor | `omm setup cursor` |
- | OpenClaw | `omm setup openclaw` |
- | Antigravity | `omm setup antigravity` |
- Run `omm setup` to auto-detect and configure all installed tools.
- ## Roadmap
- See [docs/ROADMAP.md](./docs/ROADMAP.md).
- ## Development & Contributing
- ```bash
- git clone https://github.com/oh-my-mermaid/oh-my-mermaid.git
- cd oh-my-mermaid
- npm install && npm run build
- npm test
- ```
- Issues and PRs welcome. Use [Conventional Commits](https://www.conventionalcommits.org/).
- ## License
- [MIT](./LICENSE)
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.