Skip to content

colinwilliams91/gaitor-orchestrator-cli / .agents/skills/mermaid-cli

mermaid-cli

Verified

Render Mermaid diagram definitions to image files (SVG, PNG, PDF) from the command line. Use when asked to generate or convert Mermaid diagrams to visual output files.

FileKindSize
SKILL.mdskill md2.3 KB
---
name: mermaid-cli
description: Render Mermaid diagram definitions to image files (SVG, PNG, PDF) from the command line. Use when asked to generate or convert Mermaid diagrams to visual output files.
compatibility: Requires @mermaid-js/mermaid-cli, available as a devDependency in this project. Run `npm install` then use `npx mmdc` or `npm run diagram --`.
allowed-tools: Bash(mmdc:*) Bash(npx:*) Bash(npm:*)
---

# Diagram Rendering with mermaid-cli

## Quick start

```bash
# via the project npm script (-- passes args to mmdc)
npm run diagram -- -i input.mmd -o output.svg

# or directly via npx (uses local devDependency)
npx mmdc -i input.mmd -o output.svg
```

## Commands

### Convert a file

```bash
# SVG (default)
mmdc -i diagram.mmd -o diagram.svg

# PNG
mmdc -i diagram.mmd -o diagram.png

# PDF
mmdc -i diagram.mmd -o diagram.pdf
```

### Read from stdin

```bash
echo "graph LR; A-->B" | mmdc -i - -o out.svg
```

### Common options

| Flag | Long form | Description |
|------|-----------|-------------|
| `-i` | `--input` | Input `.mmd` file, or `-` for stdin |
| `-o` | `--output` | Output file path (`.svg`, `.png`, `.pdf`) |
| `-t` | `--theme` | Theme: `default` \| `dark` \| `forest` \| `neutral` |
| `-b` | `--backgroundColor` | Background colour (`white`, `transparent`, `#ffffff`) |
| `-w` | `--width` | Canvas width in pixels (PNG only) |
| `-H` | `--height` | Canvas height in pixels (PNG only) |
| `-s` | `--scale` | Scale factor for PNG (default: `1`) |
| `-f` | `--configFile` | Path to Mermaid config JSON |
| `-C` | `--cssFile` | Path to custom CSS file |

### Examples

```bash
# Dark-themed PNG at 1200 px wide
mmdc -i architecture.mmd -o architecture.png -t dark -w 1200

# Transparent-background SVG
mmdc -i flow.mmd -o flow.svg -b transparent

# Neutral theme with custom config
mmdc -i sequence.mmd -o sequence.svg -t neutral -f mermaid.config.json
```

## Installation

`@mermaid-js/mermaid-cli` is a devDependency of this project. After `npm install`, invoke the binary via `npx`:

```bash
npx --no-install mmdc --version
```

If working outside this project and the command is not yet available locally:

```bash
npm install --save-dev @mermaid-js/mermaid-cli@latest
```

## Reference

- [mermaid-cli GitHub](https://github.com/mermaid-js/mermaid-cli)
- [Mermaid diagram syntax](https://mermaid.js.org/intro/)
canvas-designanthropics/skillsCreate beautiful visual art in .png and .pdf documents using design philosophy. You should use this skill when the user asks to create a poster, piece of art, design, or other static piece. Create original visual designs, never copying existing artists' work to avoid copyright violations.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
docxanthropics/skillsUse this skill whenever the user wants to create, read, edit, or manipulate Word documents (.docx files) or Word templates (.dotx files). Triggers include: any mention of 'Word doc', 'word document', '.docx', '.dotx', or requests to produce professional documents with formatting like tables of contents, headings, page numbers, or letterheads. Also use when extracting or reorganizing content from .docx or .dotx files, inserting or replacing images in documents, performing find-and-replace in Word files, working with tracked changes or comments, or converting content into a polished Word document. If the user asks for a 'report', 'memo', 'letter', 'template', or similar deliverable as a Word or .docx file, use this skill. Do NOT use for PDFs, spreadsheets, Google Docs, or general coding tasks unrelated to document generation.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
pdfanthropics/skillsUse this skill whenever the user wants to do anything with PDF files. This includes reading or extracting text/tables from PDFs, combining or merging multiple PDFs into one, splitting PDFs apart, rotating pages, adding watermarks, creating new PDFs, filling PDF forms, encrypting/decrypting PDFs, extracting images, and OCR on scanned PDFs to make them searchable. If the user mentions a .pdf file or asks to produce one, use this skill.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
pptxanthropics/skillsUse this skill any time a .pptx or .potx file is involved in any way — as input, output, or both. This includes: creating slide decks, pitch decks, or presentations; reading, parsing, or extracting text from any .pptx or .potx file (even if the extracted content will be used elsewhere, like in an email or summary); editing, modifying, or updating existing presentations; combining or splitting slide files; working with templates (.potx), layouts, speaker notes, or comments. Trigger whenever the user mentions "deck," "slides," "presentation," or references a .pptx or .potx filename, regardless of what they plan to do with the content afterward. If a .pptx or .potx file needs to be opened, created, or touched, use this skill.Stars: 198kUpdated Claude CodeCodexVerifiedInstall