dev-swarm-mermaid
Create Mermaid diagrams and convert them to images. Use when needing to visualize flows, architecture, or data structures.
When & Why to Use This Skill
This Claude skill enables the automated generation and conversion of Mermaid diagrams into high-quality SVG or PNG images. It streamlines the process of visualizing complex system architectures, data flows, and software structures, making it an essential tool for developers and architects to enhance technical documentation and communication.
Use Cases
- System Architecture Visualization: Automatically generate professional diagrams to represent infrastructure layouts and component interactions.
- Technical Documentation: Create and export flowcharts, sequence diagrams, and class diagrams directly into project READMEs or wikis.
- Database Modeling: Visualize entity-relationship (ER) diagrams to map out database schemas and data dependencies effectively.
- Workflow and Logic Mapping: Design state diagrams or process flows to analyze and optimize software logic or business operations.
| name | dev-swarm-mermaid |
|---|---|
| description | Create Mermaid diagrams and convert them to images. Use when needing to visualize flows, architecture, or data structures. |
Mermaid Diagram Generation
This skill provides instructions for creating Mermaid diagrams and converting them to SVG or PNG images using the Mermaid CLI (mmdc).
When to Use This Skill
- User needs to visualize flows, architecture, or data structures
- User asks to create diagrams for documentation
- User wants to convert Mermaid syntax to image files
- User needs flowcharts, sequence diagrams, class diagrams, or ER diagrams
Prerequisites
- Node.js and pnpm must be installed (refer to
dev-swarm-nodejsskill if needed).
Your Roles in This Skill
- Tech Manager (Architect): Design diagram structures to effectively communicate system architecture and data flows. Choose appropriate diagram types for different use cases. Ensure diagrams accurately represent technical concepts and relationships.
- DevOps Engineer: Execute Mermaid CLI commands to generate diagrams. Verify pnpm and Node.js installations. Convert Mermaid files to SVG or PNG formats. Troubleshoot diagram generation issues.
Role Communication
As an expert in your assigned roles, you must announce your actions before performing them using the following format:
As a {Role} [and {Role}, ...], I will {action description}
This communication pattern ensures transparency and allows for human-in-the-loop oversight at key decision points.
Installation
We recommend using pnpm dlx to execute the Mermaid CLI without a permanent global installation.
Verify mmdc availability:
pnpm dlx @mermaid-js/mermaid-cli --version
Usage
Create a Mermaid file: Create a file with
.mmdextension (e.g.,diagram.mmd) containing the Mermaid diagram definition.Example
diagram.mmd:flowchart TD A[Idea] --> B[AI Agent] B --> C[Design] C --> D[Code] D --> E[Test] E --> F[Deploy]Generate Image: Use
pnpm dlxto run the Mermaid CLI and convert the.mmdfile to an image (SVG recommended for scalability).pnpm dlx @mermaid-js/mermaid-cli -i diagram.mmd -o diagram.svgFor PNG output:
pnpm dlx @mermaid-js/mermaid-cli -i diagram.mmd -o diagram.png
Common Diagram Types
- Flowchart:
flowchart TD(Top-Down) orLR(Left-Right) - Sequence Diagram:
sequenceDiagram - Class Diagram:
classDiagram - State Diagram:
stateDiagram-v2 - Entity Relationship Diagram:
erDiagram