Agent skill

Mermaid

Render Mermaid diagrams as SVG or ASCII art using beautiful-mermaid.

MITAuto-check passedDevelopment

Install Mermaid

skills CLI

$ npx skills add peintune/runjam --skill mermaid -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI

$ gh skill install peintune/runjam mermaid --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy

$ git clone --depth 1 https://github.com/peintune/runjam.git skills-src && mkdir -p .claude/skills && cp -r skills-src/src-tauri/builtin-skills/mermaid .claude/skills/mermaid && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Paste into Claude Code

Install the "mermaid" agent skill from https://github.com/peintune/runjam/tree/main/src-tauri/builtin-skills/mermaid into .claude/skills/mermaid/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "mermaid", then confirm the skill loads.

Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

$skill-installer

$skill-installer install https://github.com/peintune/runjam/tree/main/src-tauri/builtin-skills/mermaid

Type this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.

skills CLI

$ npx skills add peintune/runjam --skill mermaid -a codex

Project install goes to .agents/skills/; add -g for ~/.codex/skills/.

GitHub CLI

$ gh skill install peintune/runjam mermaid --agent codex

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/peintune/runjam.git skills-src && mkdir -p .agents/skills && cp -r skills-src/src-tauri/builtin-skills/mermaid .agents/skills/mermaid && rm -rf skills-src

Use ~/.agents/skills/ instead of .agents/skills for a personal install.

Codex skills documentation · loads skills from .agents/skills/

Paste into Codex

Install the "mermaid" agent skill from https://github.com/peintune/runjam/tree/main/src-tauri/builtin-skills/mermaid into .agents/skills/mermaid/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "mermaid", then confirm the skill loads.

Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add peintune/runjam --skill mermaid -a cursor

Project install goes to .agents/skills/; add -g for ~/.cursor/skills/.

GitHub CLI

$ gh skill install peintune/runjam mermaid --agent cursor

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/peintune/runjam.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/src-tauri/builtin-skills/mermaid .cursor/skills/mermaid && rm -rf skills-src

Use ~/.cursor/skills/ instead of .cursor/skills for a personal install.

Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/

Paste into Cursor

Install the "mermaid" agent skill from https://github.com/peintune/runjam/tree/main/src-tauri/builtin-skills/mermaid into .cursor/skills/mermaid/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "mermaid", then confirm the skill loads.

Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

gemini skills install

$ gemini skills install https://github.com/peintune/runjam.git --path src-tauri/builtin-skills/mermaid

--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.

skills CLI

$ npx skills add peintune/runjam --skill mermaid -a gemini-cli

Project install goes to .agents/skills/; add -g for ~/.gemini/skills/.

GitHub CLI

$ gh skill install peintune/runjam mermaid --agent gemini-cli

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/peintune/runjam.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/src-tauri/builtin-skills/mermaid .gemini/skills/mermaid && rm -rf skills-src

Use ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.

Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/

Paste into Gemini CLI

Install the "mermaid" agent skill from https://github.com/peintune/runjam/tree/main/src-tauri/builtin-skills/mermaid into .gemini/skills/mermaid/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "mermaid", then confirm the skill loads.

Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

GitHub CLI

$ gh skill install peintune/runjam mermaid

Installs for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).

skills CLI

$ npx skills add peintune/runjam --skill mermaid -a github-copilot

Project install goes to .agents/skills/; add -g for ~/.copilot/skills/.

Manual copy

$ git clone --depth 1 https://github.com/peintune/runjam.git skills-src && mkdir -p .github/skills && cp -r skills-src/src-tauri/builtin-skills/mermaid .github/skills/mermaid && rm -rf skills-src

Use ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.

GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/

Paste into GitHub Copilot

Install the "mermaid" agent skill from https://github.com/peintune/runjam/tree/main/src-tauri/builtin-skills/mermaid into .github/skills/mermaid/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "mermaid", then confirm the skill loads.

GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add peintune/runjam --skill mermaid -a opencode

OpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.

GitHub CLI

$ gh skill install peintune/runjam mermaid --agent opencode

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/peintune/runjam.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/src-tauri/builtin-skills/mermaid .opencode/skills/mermaid && rm -rf skills-src

Use ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.

OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/

Paste into OpenCode

Install the "mermaid" agent skill from https://github.com/peintune/runjam/tree/main/src-tauri/builtin-skills/mermaid into .opencode/skills/mermaid/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "mermaid", then confirm the skill loads.

OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

Facts

Skill name: mermaid
GitHub stars: 228
Used in: 1 other repo
Token cost: ~729 tokens
SKILL.md length: 231 words
Files: 3 (incl. scripts, references)
Skills in repo: 7
Repo updated: Oct 5, 2026
First seen: Oct 7, 2026
Licence: MIT

At a glance

Render Mermaid diagrams as SVG or ASCII art using beautiful-mermaid.

Users need to create flowcharts
SKILL.md covers Quick Start, Supported Diagrams, Theming (SVG only) and Resources
Runs TypeScript scripts from its folder; calls npx, jq and python3
Sequence diagrams

What it does

Mermaid is an agent skill from peintune/runjam. Render Mermaid diagrams as SVG or ASCII art using beautiful-mermaid. Use when users need to create flowcharts, sequence diagrams, state diagrams, class diagrams, or ER diagrams. Supports both graphical SVG output and terminal-friendly ASCII/Unicode output.

Its SKILL.md is about 730 tokens, which your agent loads only when the skill is triggered. The skill folder holds 4 other files, including scripts and reference files (for example `references/syntax.md` and `scripts/render.ts`).

It sits in Development, covering Diagrams. It works with Mermaid and Bash. The repository describes itself as: One desktop for all your AI coding Agent — Claude Code, Codex CLI & Gemini CLI. Auto-detect, one-click install, unified chat, file explorer, terminal & editor. Local-first. Built… The licence is MIT.

When your agent uses it

Users need to create flowcharts
Sequence diagrams

Example prompts

“/mermaid”

Requirements

Python 3
Node.js

What it can do on your machine

Read from SKILL.md and the folder at commit b186c61. It shows what the files ask for, not the result of running them.

Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
Ships 1 file in scripts/ (TypeScript), which the agent can run.
Shell commands in SKILL.md call:
- npx
- jq
- python3
- python
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md. Its commands use npx, which can reach the network depending on how they are called.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Mermaid loads about 729 tokens when it runs, and up to ~1.1k if it reads all its reference files. Until then it costs about 66 tokens; SKILL.md has 231 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it: ~66
When it runs · the whole SKILL.md, loaded when a task matches: ~729
With references · SKILL.md plus every file in references/, read only if the agent opens them: ~1.1k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); the scripts in this folder are not scanned.

SKILL.md

The full file from peintune/runjam at commit b186c61, republished under its MIT licence (© peintune). 231 words, ~729 tokens.

Download SKILL.mdSave it as .claude/skills/mermaid/SKILL.md (or your agent's skills folder). This skill also uses 2 other files; get the full folder from GitHub.

name: mermaid
description: Render Mermaid diagrams as SVG or ASCII art using beautiful-mermaid. Use when users need to create flowcharts, sequence diagrams, state diagrams, class diagrams, or ER diagrams. Supports both graphical SVG output and terminal-friendly ASCII/Unicode output.

⚠️ Platform note — read before running any command. The shell snippets in this skill are written for macOS / Linux (bash/zsh). Always check which OS you are on first. On Windows do not run them verbatim — the underlying tool/CLI commands are usually cross-platform, but the surrounding shell syntax is not. Translate it to PowerShell before running:

bash (macOS / Linux) PowerShell (Windows)
a && b run as two steps, or a; if ($?) { b }
cat <<'EOF' | tool … (heredoc) write the text to a temp file, then pipe/pass that file to the tool
VAR=$(cmd) … $VAR $VAR = cmd … $VAR
cmd > /dev/null cmd > $null
… | grep PAT … | Select-String PAT
… | jq … … | ConvertFrom-Json, then read the fields
python3 x.py python x.py (or py x.py)
~/dir, /tmp $env:USERPROFILE\dir, $env:TEMP
cp / mkdir -p / rm -rf Copy-Item / New-Item -ItemType Directory -Force / Remove-Item -Recurse -Force

If a command has no obvious Windows equivalent, prefer the built-in file/HTTP tools over raw shell.

bash (macOS / Linux)	PowerShell (Windows)
`a && b`	run as two steps, or `a; if ($?) { b }`
`cat <<'EOF' \| tool …` (heredoc)	write the text to a temp file, then pipe/pass that file to the tool
`VAR=$(cmd)` … `$VAR`	`$VAR = cmd` … `$VAR`
`cmd > /dev/null`	`cmd > $null`
`… \| grep PAT`	`… \| Select-String PAT`
`… \| jq …`	`… \| ConvertFrom-Json`, then read the fields
`python3 x.py`	`python x.py` (or `py x.py`)
`~/dir`, `/tmp`	`$env:USERPROFILE\dir`, `$env:TEMP`
`cp` / `mkdir -p` / `rm -rf`	`Copy-Item` / `New-Item -ItemType Directory -Force` / `Remove-Item -Recurse -Force`

Mermaid Diagram Renderer

Render Mermaid diagrams using beautiful-mermaid library. Supports 5 diagram types with dual output modes.

Quick Start

Dependencies (beautiful-mermaid) auto-install on first run.

SVG Output (Default)

bash

# From file
npx tsx scripts/render.ts diagram.mmd --output diagram.svg

# From stdin
echo "graph LR; A-->B-->C" | npx tsx scripts/render.ts --stdin --output flow.svg

ASCII Output (Terminal)

bash

# ASCII art for terminal display
npx tsx scripts/render.ts diagram.mmd --ascii

# Pipe directly
echo "graph TD; Start-->End" | npx tsx scripts/render.ts --stdin --ascii

Output example:

┌───────┐     ┌─────┐
│ Start │────▶│ End │
└───────┘     └─────┘

Supported Diagrams

Type	Syntax	Best For
Flowchart	`graph TD/LR`	Processes, decisions
Sequence	`sequenceDiagram`	API calls, interactions
State	`stateDiagram-v2`	State machines
Class	`classDiagram`	OOP design
ER	`erDiagram`	Database schemas

Theming (SVG only)

bash

npx tsx scripts/render.ts diagram.mmd --theme github-dark --output out.svg

Use invalid theme name to see available themes list (e.g., --theme ?)

Resources

scripts/render.ts - Main rendering script
references/syntax.md - Mermaid syntax quick reference

Files

SKILL.md and 2 other files (scripts, references) in src-tauri/builtin-skills/mermaid of peintune/runjam.

SKILL.md
references/syntax.md
scripts/render.ts

Open the folder on GitHubat commit b186c61

Used in 1 other repository

We found 1 copy of this SKILL.md (exact, near-identical or edited) in other folders, from 1 other GitHub owner. This page covers the copy in peintune/runjam, which our catalogue first saw on October 7, 2026.

FerroxLabs/waylandsrc/process/resources/skills/mermaid

Compare with similar skills

Mermaid next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Mermaid compared with similar skills
Skill	Stars	Used in	Tokens	Auto-check	Licence	Repo updated
Mermaid this skillpeintune/runjam	228	1 repos	~729	Automated safety check: Pass	MIT	5 days ago
Omm Pushoh-my-mermaid/oh-my-mermaid	2.7k	—	~441	Automated safety check: Pass	MIT	6 mo ago
Archify Diagramstt-a1i/archify	81k	—	~2.9k	Automated safety check: Pass	MIT	today
Diagram Designcathrynlavery/diagram-design	48k	1 repos	~7.6k	Automated safety check: Pass	MIT	today
Draw.io Diagram StudioAgents365-ai/drawio-skill	10k	—	~2.4k	Automated safety check: Notes	MIT	7 days ago
Pretty Mermaid Rendererimxv/Pretty-mermaid-skills	1.5k	—	~2k	Automated safety check: Pass	MIT	1 mo ago

Similar skills

Omm Push
oh-my-mermaid/oh-my-mermaid
Push architecture docs to oh-my-mermaid cloud. An agent skill from oh-my-mermaid/oh-my-mermaid.
2.7k GitHub stars~441 tokensUpdated 6 mo ago
DevelopmentAuto-check passed
Archify Diagrams
tt-a1i/archify
Creates interactive architecture, workflow, sequence, data-flow and lifecycle diagrams as standalone HTML with inline SVG, themes and image or video export.
81k GitHub stars~2.9k tokensUpdated today
DevelopmentAuto-check passed
Diagram Design
cathrynlavery/diagram-design
Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.
48k GitHub starsUsed in 1 repo~7.6k tokens
DevelopmentAuto-check passed
Draw.io Diagram Studio
Agents365-ai/drawio-skill
Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.
10k GitHub stars~2.4k tokensUpdated 7 days ago
DevelopmentAuto-check: notes
Pretty Mermaid Renderer
imxv/Pretty-mermaid-skills
Writes and renders Mermaid diagrams as themed SVG, PNG or terminal ASCII and Unicode art with a bundled Node.js CLI that needs no browser.
1.5k GitHub stars~2k tokensUpdated 1 mo ago
DevelopmentAuto-check passed
Archify Diagram Builder
Unclecheng-li/AI_Animation
Builds validated architecture, workflow, sequence, data-flow and lifecycle diagrams as standalone interactive HTML from a small JSON spec, with optional motion and image export.
1.5k GitHub starsUsed in 2 repos~4.1k tokens
DevelopmentAuto-check passed

Questions about Mermaid

What does Mermaid do?

Render Mermaid diagrams as SVG or ASCII art using beautiful-mermaid. Mermaid is an agent skill from peintune/runjam. Render Mermaid diagrams as SVG or ASCII art using beautiful-mermaid.

When should I use Mermaid?

Mermaid fits situations like: users need to create flowcharts; sequence diagrams.

How do I install Mermaid in Claude Code?

Run `npx skills add peintune/runjam --skill mermaid -a claude-code`. Or copy the skill folder (src-tauri/builtin-skills/mermaid in peintune/runjam) into .claude/skills/mermaid in your project. Claude Code loads it when a task matches its description.

How do I install Mermaid in Codex?

Run `npx skills add peintune/runjam --skill mermaid -a codex`. Or copy the skill folder (src-tauri/builtin-skills/mermaid in peintune/runjam) into .agents/skills/mermaid in your project. Codex loads it when a task matches its description.

Can I use Mermaid in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add peintune/runjam --skill mermaid -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/mermaid, .gemini/skills/mermaid, .github/skills/mermaid and .opencode/skills/mermaid in your project.

What does Mermaid need to run?

Going by SKILL.md and its folder, Mermaid needs TypeScript for the scripts in its folder and the command-line tools its instructions call (npx, jq, python3 and python). Our summary lists: Python 3; Node.js.

Does Mermaid access the network?

SKILL.md contains no URLs. Its commands use npx, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Mermaid safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.

What licence does Mermaid use?

Mermaid is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Mermaid use?

About 729 tokens (SKILL.md is roughly 2.9k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 332 tokens, read only when the agent opens those files.

What are the alternatives to Mermaid?

Skills that share tags, products or a category with Mermaid: Omm Push (oh-my-mermaid/oh-my-mermaid, 2.7k stars), Archify Diagrams (tt-a1i/archify, 81k stars), Diagram Design (cathrynlavery/diagram-design, 48k stars) and Draw.io Diagram Studio (Agents365-ai/drawio-skill, 10k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Mermaid?

peintune (a GitHub user) maintains it in peintune/runjam, which has 228 GitHub stars. The repository holds 7 skills in this directory. The repository was last updated on October 5, 2026.

Source: peintune/runjam on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.

Install Mermaid

Facts

At a glance

What it does

When your agent uses it

Example prompts

Requirements

What it can do on your machine

Tool permissions

Runs code

Network

Credentials

Context cost

Safety

SKILL.md

Mermaid Diagram Renderer

Quick Start

SVG Output (Default)

ASCII Output (Terminal)

Supported Diagrams

Theming (SVG only)

Resources

Files

Used in 1 other repository

Compare with similar skills

Similar skills

More from peintune/runjam

Related

Questions about Mermaid