How do I install oh-my-mermaid?

Run these in Claude Code: /plugin marketplace add oh-my-mermaid/oh-my-mermaid then /plugin install oh-my-mermaid@oh-my-mermaid. Then prompt normally.

Does oh-my-mermaid auto-invoke its skills?

Not yet. It is indexed on Flowy as a plain plugin. Request auto-invocation on its page and Flowy will route its skills for you as you prompt.

Is oh-my-mermaid free?

Yes. Flowy is free and open source, with nothing gated. You can read every skill in full before you install.

Documentation

Plugin

oh-my-mermaid

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

FLOW.md

oh-my-mermaid@oh-my-mermaid

GitHub

Plugin Signal54/100Fair

maintained43

capable29

documented100

adopted71

Install on Claude Code

> /plugin marketplace add oh-my-mermaid/oh-my-mermaid
> /plugin install oh-my-mermaid@oh-my-mermaid

Stats

TypeScript Node Bash Git GitHub

+2 tags

Mermaid Anthropic

2,168

Stars

185

Forks

Maintained

Maintenance

TypeScript

Language

MIT

License

4mo ago

Last commit

4mo ago

Created

Repo: oh-my-mermaid/oh-my-mermaid

In this plugin

3 skills

See everything inside

What's inside

Skills

/omm-pushPush architecture docs to oh-my-mermaid cloud. Handles login, link, and push workflow with error guidance. Use when the user says "omm push", "push to cloud", "deploy architecture", or "share architecture"./omm-scanScan codebase architecture and generate/update .omm/ documentation. Use when the user says "omm scan", "scan architecture", "update architecture", "refresh diagrams"./omm-viewStart the omm web viewer to explore architecture diagrams in the browser. Use when the user says "omm view", "open viewer", "show diagrams", "view architecture", or "open architecture".

README

Read on GitHub

English | Türkçe | 한국어 | 日本語 | 中文

Quick Start

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

Example

omm scanned itself. This is what it found.

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

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.

omm login && omm link && omm push

It's private by default. Share with your team, or make it public like this example.

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.

Development & Contributing

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.

License

MIT

File tree

212

oh-my-mermaid/oh-my-mermaidView on GitHub

.claude-plugin/
  marketplace.json
  plugin.json
.github/
  workflows/
    check-version-sync.yml
    release.yml
.gitignore
.omm/
  command-surface/
    class-field/
      description.md
      meta.yaml
    delete/
      description.md
      meta.yaml
    description.md
    diagram.mmd
    diff/
      description.md
      meta.yaml
    init/
      description.md
      meta.yaml
    link/
      description.md
      meta.yaml
    list/
      description.md
      meta.yaml
    login/
      description.md
      meta.yaml
    logout/
      description.md
      meta.yaml
    meta.yaml
    omm/
      description.md
      meta.yaml
    org/
      description.md
      meta.yaml
    pull/
      description.md
      meta.yaml
    push/
      description.md
      meta.yaml
    refs/
      description.md
      meta.yaml
    setup/
      description.md
      meta.yaml
    share/
      description.md
      meta.yaml
    show/
      description.md
      meta.yaml
    status/
      description.md
      meta.yaml
    update/
      description.md
      meta.yaml
    validate/
      description.md
      meta.yaml
    view/
      description.md
      meta.yaml
  config.yaml
  data-flow/
    ai-assistant/
      description.md
      meta.yaml
    cli-input/
      description.md
      meta.yaml
    cloud-api/
      description.md
      meta.yaml
    credentials/
      description.md
      meta.yaml
    description.md
    diagram.mmd
    diff-engine/
      description.md
      meta.yaml
    meta-tracker/
      description.md
      meta.yaml
    meta.yaml
    omm-dir/
      description.md
      meta.yaml
    ref-tracker/
      description.md
      meta.yaml
    store/
      description.md
      meta.yaml
    validator/
      description.md
      meta.yaml
    web-viewer/
      description.md
      meta.yaml
  overall-architecture/
    cli/
      description.md
      meta.yaml
    cloud/
    cloud-paths/
      description.md
      meta.yaml
      description.md
      meta.yaml
    commands/
      class-field/
        description.md
        meta.yaml
      cloud-ops/
        description.md
        meta.yaml
      description.md
      diagram.mmd
      local-ops/
        description.md
        meta.yaml
      meta.yaml
      query-ops/
        description.md
        meta.yaml
      tool-ops/
        description.md
        meta.yaml
    constraint.md
    context.md
    description.md
    diagram.mmd
    diff-engine/
      description.md
      meta.yaml
    meta/
    meta.yaml
      description.md
      meta.yaml
    platforms/
      antigravity-platform/
        description.md
        meta.yaml
      claude-platform/
        description.md
        meta.yaml
      codex-platform/
        description.md
        meta.yaml
      cursor-platform/
        description.md
        meta.yaml
      description.md
      diagram.mmd
      meta.yaml
      openclaw-platform/
        description.md
        meta.yaml
      platform-interface/
        description.md
        meta.yaml
      platform-registry/
        description.md
        meta.yaml
    public-api/
      description.md
      meta.yaml
    refs/
      description.md
      meta.yaml
    server/
      api-handler/
        description.md
        meta.yaml
      description.md
      diagram.mmd
      http-server/
        description.md
        meta.yaml
      meta.yaml
      viewer-html/
        description.md
        meta.yaml
      watcher/
        description.md
        meta.yaml
    store/
      description.md
      meta.yaml
    validator/
      description.md
      meta.yaml
CLAUDE.md
docs/
  demo.gif
  logo.jpg
  ROADMAP.md
  screenshot.png
LICENSE
package-lock.json
package.json
PLAN.md
README.ja.md
README.ko.md
README.md
README.tr.md
README.zh.md
scripts/
  check-version-sync.js
  release-decision.js
  sync-version.js
skills/
  omm-push/
    SKILL.md
  omm-scan/
    SKILL.md
  omm-view/
    SKILL.md
src/
  __tests__/
    cloud-paths.test.ts
    credentials.test.ts
    cursor.test.ts
    release-decision.test.ts
    store.test.ts
    update.test.ts
    validate.test.ts
    version-sync.test.ts
  cli.ts
  commands/
    class-field.ts
    config.ts
    delete.ts
    diff.ts
    init.ts
    link.ts
    list.ts
    login.ts
    logout.ts
    org.ts
    pull.ts
    push.ts
    read-write.ts
    refs.ts
    setup.ts
    share.ts
    show.ts
    status.ts
    tree.ts
    update.ts
    validate.ts
    view.ts
  index.ts
  lib/
    cloud-paths.ts
    cloud.ts
    diff.ts
    meta.ts
    platforms/
      antigravity.ts
      claude.ts
      codex.ts
      cursor.ts
      index.ts
      openclaw.ts
      types.ts
      utils.ts
    refs.ts
    store.ts
    validate.ts
  server/
    api.ts
    index.ts
    viewer.html
    watcher.ts
  types.ts
tsconfig.json
tsup.config.ts

FAQ

oh-my-mermaid is a Claude Code plugin with 3 hand-picked skills for documentation work, indexed on Flowy. Install it with the command on its page. It includes omm-push, omm-scan, omm-view. Its skills do not fire on their own yet. Request auto-invocation to have Flowy route them as you prompt. Free and open source.

What is oh-my-mermaid?: Turn complex codebases into clear, navigable architecture diagrams with Claude Code.
How do I install oh-my-mermaid?: Run these in Claude Code: /plugin marketplace add oh-my-mermaid/oh-my-mermaid then /plugin install oh-my-mermaid@oh-my-mermaid. Then prompt normally.
Does oh-my-mermaid auto-invoke its skills?: Not yet. It is indexed on Flowy as a plain plugin. Request auto-invocation on its page and Flowy will route its skills for you as you prompt.
Is oh-my-mermaid free?: Yes. Flowy is free and open source, with nothing gated. You can read every skill in full before you install.

How It Works

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.

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

Skill

What it does

/omm-scan

Analyze codebase → generate architecture docs

/omm-push

Platform

Setup

Claude Code

omm setup claude

Codex

omm setup codex

Cursor

omm setup cursor

OpenClaw

omm setup openclaw

Antigravity

omm setup antigravity

.claude-plugin/ marketplace.json plugin.json .github/ workflows/ check-version-sync.yml release.yml .gitignore .omm/ command-surface/ class-field/ description.md meta.yaml delete/ description.md meta.yaml description.md diagram.mmd diff/ description.md meta.yaml init/ description.md meta.yaml link/ description.md meta.yaml list/ description.md meta.yaml login/ description.md meta.yaml logout/ description.md meta.yaml meta.yaml omm/ description.md meta.yaml org/ description.md meta.yaml pull/ description.md meta.yaml push/ description.md meta.yaml refs/ description.md meta.yaml setup/ description.md meta.yaml share/ description.md meta.yaml show/ description.md meta.yaml status/ description.md meta.yaml update/ description.md meta.yaml validate/ description.md meta.yaml view/ description.md meta.yaml config.yaml data-flow/ ai-assistant/ description.md meta.yaml cli-input/ description.md meta.yaml cloud-api/ description.md meta.yaml credentials/ description.md meta.yaml description.md diagram.mmd diff-engine/ description.md meta.yaml meta-tracker/ description.md meta.yaml meta.yaml omm-dir/ description.md meta.yaml ref-tracker/ description.md meta.yaml store/ description.md meta.yaml validator/ description.md meta.yaml web-viewer/ description.md meta.yaml overall-architecture/ cli/ description.md meta.yaml cloud/ cloud-paths/ description.md meta.yaml description.md meta.yaml commands/ class-field/ description.md meta.yaml cloud-ops/ description.md meta.yaml description.md diagram.mmd local-ops/ description.md meta.yaml meta.yaml query-ops/ description.md meta.yaml tool-ops/ description.md meta.yaml constraint.md context.md description.md diagram.mmd diff-engine/ description.md meta.yaml meta/ meta.yaml description.md meta.yaml platforms/ antigravity-platform/ description.md meta.yaml claude-platform/ description.md meta.yaml codex-platform/ description.md meta.yaml cursor-platform/ description.md meta.yaml description.md diagram.mmd meta.yaml openclaw-platform/ description.md meta.yaml platform-interface/ description.md meta.yaml platform-registry/ description.md meta.yaml public-api/ description.md meta.yaml refs/ description.md meta.yaml server/ api-handler/ description.md meta.yaml description.md diagram.mmd http-server/ description.md meta.yaml meta.yaml viewer-html/ description.md meta.yaml watcher/ description.md meta.yaml store/ description.md meta.yaml validator/ description.md meta.yaml CLAUDE.md docs/ demo.gif logo.jpg ROADMAP.md screenshot.png LICENSE package-lock.json package.json PLAN.md README.ja.md README.ko.md README.md README.tr.md README.zh.md scripts/ check-version-sync.js release-decision.js sync-version.js skills/ omm-push/ SKILL.md omm-scan/ SKILL.md omm-view/ SKILL.md src/ __tests__/ cloud-paths.test.ts credentials.test.ts cursor.test.ts release-decision.test.ts store.test.ts update.test.ts validate.test.ts version-sync.test.ts cli.ts commands/ class-field.ts config.ts delete.ts diff.ts init.ts link.ts list.ts login.ts logout.ts org.ts pull.ts push.ts read-write.ts refs.ts setup.ts share.ts show.ts status.ts tree.ts update.ts validate.ts view.ts index.ts lib/ cloud-paths.ts cloud.ts diff.ts meta.ts platforms/ antigravity.ts claude.ts codex.ts cursor.ts index.ts openclaw.ts types.ts utils.ts refs.ts store.ts validate.ts server/ api.ts index.ts viewer.html watcher.ts types.ts tsconfig.json tsup.config.ts