mcpField
O
omm-view

omm-view

github.com/oh-my-mermaidDevelopment3.4k65 installsUpdated 29w ago
Repository

About omm-view

A skill for launching an interactive web viewer to explore `.omm/` architecture diagrams in a browser. It checks for existing documentation first and suggests `/omm-scan` if none is found.

Key features

  1. 01Check for existing architecture documentation
  2. 02Launch the interactive diagram viewer
  3. 03Allow a specified port
  4. 04Auto-refresh when files change
  5. 05Browse documentation in read-only mode

Use cases

  1. 01Explore `.omm/` architecture diagrams in a browser
  2. 02Run the local viewer on a chosen port
  3. 03Review diagrams after documentation changes

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/oh-my-mermaid/oh-my-mermaid --skill omm-view

After installing, type/omm-viewin Claude Code to confirm it loaded.

Details

From the project README

omm-view — Architecture Viewer

Purpose

Launch the interactive web viewer so the user can explore .omm/ architecture diagrams in their browser.

Prerequisites

Ensure the omm CLI is available:

command -v omm || npm install -g oh-my-mermaid

If the install command fails (permission denied), tell the user: "Please run npm install -g oh-my-mermaid in your terminal, then try again."

Steps

Step 1: Verify .omm/ exists
omm list

If no classes found, tell the user: "No architecture docs found. Run /omm-scan first to generate them." Then stop.

Step 2: Start the viewer
omm view

If the user specified a port:

omm view --port <port>
Step 3: Report

Tell the user the viewer is running and provide the URL (default: http://localhost:3000).

The viewer auto-refreshes when .omm/ files change.

Rules

  • Always check for existing classes before starting the viewer
  • If no classes exist, suggest /omm-scan instead of starting an empty viewer
  • The viewer is read-only — it does not modify .omm/ files

Comments

Markdown supported