OpenParable
Skip to content
← Back to skills

Omm View

Apps & Automation
omm-view

Omm View is an Agent Skill for apps & automation published in the oh-my-mermaid/oh-my-mermaid repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Start 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".

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/oh-my-mermaid/oh-my-mermaid/blob/HEAD/skills/omm-view/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/omm-view, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

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