| name | description |
|---|---|
mermaid-ascii-diagrams |
Render Mermaid diagrams as terminal-friendly ASCII using a local mermaid-ascii binary. Use when an explanation or planning discussion needs a visual of component interactions, data flow, process steps, decision paths, or sequence/state transitions. |
Use this skill to turn Mermaid snippets into ASCII diagrams directly in the terminal. Apply it to architecture explanations and planning conversations where visual structure improves clarity.
- Decide if a diagram improves understanding. Prefer diagrams when multiple entities interact, branching exists, or ordering matters.
- Draft Mermaid source from verified context only.
- Render with
scripts/render_mermaid_ascii.sh. - If rendering fails, fix Mermaid syntax and render again.
- Return:
- The ASCII output in a fenced
textblock. - A short explanation tied to the user's question.
Render from stdin (default behavior when --file is not passed):
cat <<'EOF' | scripts/render_mermaid_ascii.sh --ascii
flowchart TD
User --> API
API --> DB[(Database)]
EOFRender from a Mermaid file:
scripts/render_mermaid_ascii.sh --file /tmp/diagram.mmd --asciiRender with Unicode border characters (default style):
cat /tmp/diagram.mmd | scripts/render_mermaid_ascii.sh- Use
flowchart TDfor component/data flow and planning pipelines. - Use
sequenceDiagramfor request/response timelines. - Keep diagrams under ~12 nodes; split larger systems into focused diagrams.
- Name nodes by responsibility (
Auth Service,Queue Worker) rather than low-level implementation details. - Keep one primary story per diagram.
scripts/render_mermaid_ascii.sh: Wrapper aroundmermaid-asciithat defaults to stdin input (-f -) and validates binary availability.