gen-readme-diagram

gen-readme-diagram is a skill for Claude Code from sgaunet/claude-plugins. It costs 22 tokens per session (8,191 once invoked), scanned C, original, MIT.

A tool that adds or updates an Architecture section in a project's README using Mermaid diagrams. Mermaid is a text format that GitHub, GitLab, and Forgejo can display as diagrams without committed image files.

In plain words
What is it for?
Use it to document a repository's architecture in its README, with the number of diagrams matched to the system's complexity.
Why use it?
It helps newcomers see how a project connects to databases, queues, services, and outside APIs instead of finding only setup instructions. Text-based diagrams are easier to review and update than screenshots.

Skill for Claude Code

Written for Claude Code: allowed-tools in frontmatter. Also seen: names the AskUserQuestion tool; mentions Claude Code.

Runs only inside its plugin — its command needs a path that Claude Code sets for a plugin’s own hooks and for nothing else. Install the plugin, not this.

Part of the software-engineering plugin — 18 skills, 7 agents shipped together

Good fit Use it to document a repository's architecture in its README, with the number of diagrams matched to the system's complexity.

Compare 6 skills from other repositories ↓
Install

Getting it into your agent

This one installs as part of its plugin. Adding the marketplace and installing the plugin brings it with everything else the plugin ships.

Claude Code
/plugin marketplace add sgaunet/claude-plugins
Claude Code
/plugin install software-engineering

Made for: Claude Code.

Or install software-engineering, the plugin that ships this one along with the rest of its 18 skills, 7 agents.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for gen-readme-diagram

README.md
[![agentmods](https://agentmods.dev/badge/skills/sgaunet/claude-plugins/gen-readme-diagram/github.svg)](https://agentmods.dev/skills/sgaunet/claude-plugins/gen-readme-diagram)
Your own site
<a href="https://agentmods.dev/skills/sgaunet/claude-plugins/gen-readme-diagram"><img src="https://agentmods.dev/badge/skills/sgaunet/claude-plugins/gen-readme-diagram/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for gen-readme-diagram

Your own site · 80×15
<a href="https://agentmods.dev/skills/sgaunet/claude-plugins/gen-readme-diagram"><img src="https://agentmods.dev/badge/skills/sgaunet/claude-plugins/gen-readme-diagram.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 22 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 8,191 The whole file, excluding the scripts and references it only reads on demand.
Security scan C 2 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00022 $0.08191
Opus 5.5 $0.00009 $0.03276
Sonnet 5.5 $0.00004 $0.01638
Haiku 4.5 $0.00002 $0.00819

Measured 22d ago against content hash 5705445f8673, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade C, and why

gen-readme-diagram scanned grade C with 2 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 22d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Downloads and executes remote codehighSupply chain

curl | sh runs whatever the server returns today, which is not necessarily what it returned when this was reviewed.

• Linux: curl -fsSL https://d2lang.com/install.sh | sh -s --

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

• Linux: curl -fsSL https://d2lang.com/install.sh | sh -s --
plugins/software-engineering/skills/gen-readme-diagram/SKILL.md · 698 lines

How it starts

The opening of the file, as written. The whole thing — 698 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Generate README Architecture Diagrams

Add or update an ## Architecture section in the current project's README, containing Mermaid diagrams sized to the application's actual complexity. Mermaid renders natively on GitHub, GitLab and Forgejo, so the section needs no build step and no committed image. Re-running the skill replaces only its own generated block and never disturbs hand-written prose.

Why This Skill Exists

Problem: READMEs describe how to run a project but almost never what it talks to. A newcomer cannot tell from the README whether the service owns a database, calls three SaaS APIs, or consumes a queue. Drawing that by hand means picking a tool, learning its syntax, and — for anything image-based — committing a binary that silently drifts from reality. Meanwhile /gen-diagram produces excellent d2 + SVG output for design docs, but a README wants something that renders inline, for free, forever.

Solution: One invocation that:

  • Analyzes the repo it is invoked in and scores its complexity on a fixed rubric
  • Emits a diagram set matched to that score — from no diagram at all for a single-purpose library, up to four views for a multi-service system
  • Always includes the global/context view: the app as one box, with every external system and every edge labelled
  • Splices into the README between generated markers, so re-running is idempotent and hand-written prose survives

Content Generation Rules

CRITICAL: When generating any content (README sections, Mermaid source, .d2 source, prose, or any other output):

  • NEVER add Claude Code attribution or co-authorship
  • NEVER include phrases like "Generated by Claude", "Created with Claude Code", or similar
  • NEVER add "Co-Authored-By: Claude" in commit messages or documentation
  • All generated content should appear as if written by a human developer
  • Focus on technical accuracy and clear, readable diagrams

Process (6 Phases)

Phase 1: Prerequisites Validation

Read the full file on GitHub · 698 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 22d ago First seen · 698 lines · 22 tokens per session scan C 5705445f8673

Subscribe to this mod's changes

gen-readme-diagram is a skill published in the GitHub repository sgaunet/claude-plugins (16 stars, last pushed 8d ago), licensed MIT. It adds 22 tokens to every session and 8,191 once invoked, about $0.0001 per session on Opus 5.5. A static security scan graded it C with 2 findings (downloads and executes remote code, makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-25.

Related

Other skills, from other repositories

customer-journey-map

Create an end-to-end customer journey map with stages, touchpoints, emotions, pain points, and opportunities. Use when mapping the customer experience, identifying friction points, improving onboarding, or visualizing the user journey.

phuryn/pm-skills · 49 tokens

visual-explainer

Generate self-contained HTML pages that visually explain technical material — systems, code changes, plans, data. Use when the user asks for any diagram or visual explanation, when they want a slide deck or a longform document (user guide, how-to, reference page), when another skill needs one rendered, or proactively…

NikiforovAll/claude-code-rules · 84 tokens

brand

A project-specific visual identity for chat cards and saved reports, using the project's colors, logo, and fonts. It finds these details in the repository or asks the user for them, then stores the result in a committable `.readable/` folder.

smk-labs/claude-plugins · 64 tokens

verifying-design-canvas

Verify a live deployed app matches its Claude Design canvas (.dc.html): theme tokens, DOM/a11y structure, every interactive state — not just default view. Building instead of verifying? See artifact-design.

qte77/claude-code-plugins · 47 tokens

auditing-website-accessibility

Audits website accessibility for WCAG 2.2 AA compliance, generating findings and code fixes. Use when reviewing accessibility, keyboard navigation, screen reader compatibility, or inclusive design.

qte77/claude-code-plugins · 43 tokens

auditing-website-usability

Audits website usability for UX optimization, covering forms, navigation, validation, and microcopy. Use when reviewing user experience, task completion flows, or interface friction points.

qte77/claude-code-plugins · 41 tokens