Oh-my-mermaid transforms complex codebases into navigable architecture diagrams using AI, addressing the challenge of understanding intricate software systems. It serves engineers and developers by automatically generating documentation and visual representations, significantly reducing the time and effort required to grasp a project's architecture. The primary benefit is making codebases accessible and understandable, even for those unfamiliar with them.

How It Works

The core approach involves an AI analyzing a codebase to generate distinct "perspectives," offering different views like structure, data flow, and integrations. Each perspective comprises a Mermaid diagram and associated documentation fields. Complex code elements are recursively analyzed and represented as nested child diagrams within a hierarchical filesystem structure (e.g., .omm/overall-architecture/main-process/). This structure allows the viewer to automatically render expandable groups for nested elements and individual nodes for simpler components, with each element supporting up to seven documentation fields.

Quick Start & Requirements

• Primary install/run command:

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

• Prerequisites: Node.js and npm are required for installation. Integration with supported AI coding tools (e.g., Claude Code, Codex, Cursor) is necessary to use the /omm-scan skill.
• Setup: Run omm setup to auto-detect and configure installed AI tools.
• Relevant pages: Roadmap is available at docs/ROADMAP.md.

Highlighted Details

• AI-driven generation of architecture diagrams and documentation.
• Recursive analysis leading to deeply nested, hierarchical diagram structures.
• Filesystem mirroring the architectural tree for intuitive navigation.
• Broad compatibility with popular AI coding platforms.
• Optional cloud storage and sharing via ohmymermaid.com.

Maintenance & Community

Development follows Conventional Commits, with issues and pull requests welcomed. The project can be built locally via npm install && npm run build and tested with npm test. A roadmap is available in docs/ROADMAP.md. No specific community channels (like Discord or Slack) or notable contributors/sponsorships are detailed in the provided README snippet.

Licensing & Compatibility

The project is licensed under the MIT license. This permissive license allows for broad compatibility, including commercial use and integration within closed-source projects without significant restrictions.

Limitations & Caveats

The provided README does not explicitly detail limitations such as alpha status, known bugs, or unsupported platforms. The effectiveness of the generated diagrams is contingent on the AI's analysis capabilities and the complexity/structure of the codebase being scanned. Integration requires the use of specifically supported AI coding tools.