plantuml

Generate PlantUML diagrams from text descriptions and convert them to PNG or SVG images.

Updated Aug 24, 2026
One-click install
npx skills add https://github.com/aggutierrez98/TP-TD --skill plantuml-aggutierrez98
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: plantuml
Source: https://github.com/aggutierrez98/TP-TD/tree/main/.agents/skills/tp-delivery-standards/embedded-skills/plantuml
Command: npx skills add https://github.com/aggutierrez98/TP-TD --skill plantuml-aggutierrez98

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve? Creating and maintaining architecture and UML diagrams manually is slow and hard to version-control, and documentation platforms like Confluence or Notion cannot render PlantUML code blocks natively. This Skill generates PlantUML syntax from natural language, converts .puml files and markdown-embedded diagrams to images, and validates syntax for CI/CD pipelines. ## Core Features & Use Cases - Diagram Generation: Create all 19 PlantUML diagram types (sequence, class, ER, activity, state, Gantt, mindmap, deployment, and more) from plain-language descriptions, with styling themes and Unicode symbol enrichment. - Markdown Processing: Extract embedded ```puml blocks and linked .puml files from markdown, convert them to PNG/SVG images, and rewrite the markdown with image links for Confluence or Notion upload. - Code-to-Diagram Conversion: Map Spring Boot, FastAPI, Python ETL, Node.js, and React codebases to deployment, component, and sequence diagrams using ready-made example templates. - Use Case: Before uploading a design document to Confluence, run the markdown processor to convert every PlantUML block into an image link, then validate all diagram syntax in CI with the --validate flag. ## Quick Start Use the plantuml skill to create a sequence diagram for the user authentication flow and convert it to an SVG image.

Frequently Asked Questions about plantuml

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I convert a PlantUML .puml file to PNG or SVG?▼

Run the convert_puml.py script with the file path and optional --format svg flag. It invokes plantuml.jar via Java and writes the image to the same directory or a specified --output-dir.

How to convert PlantUML diagrams in markdown for Confluence?▼

Use process_markdown_puml.py on the markdown file before uploading. It converts both embedded puml code blocks and linked .puml files into images and produces a new markdown file with image links that Confluence can render.

What diagram types does PlantUML support?▼

This skill covers all 19 PlantUML types: UML diagrams (sequence, class, activity, state, component, deployment, use case, object, timing) and non-UML diagrams (ER, Gantt, mindmap, WBS, network, JSON/YAML, Archimate, wireframes, timeline).

Can I validate PlantUML syntax in a CI pipeline without generating images?▼

Yes. Run process_markdown_puml.py with the --validate flag. It checks all embedded and linked diagrams, reports errors with line numbers, and returns a non-zero exit code on failure, making it suitable for pre-commit hooks and CI jobs.

Why does PlantUML fail with 'plantuml.jar not found' or 'Graphviz not found'?▼

PlantUML requires Java 8+, the plantuml.jar file, and Graphviz for most UML layouts. Place plantuml.jar in your home directory or set the PLANTUML_JAR environment variable, add Graphviz's dot executable to PATH, then verify with check_setup.py.

Why do I get 'Syntax Error?' when my PlantUML diagram looks correct?▼

Common causes are mismatched @startuml/@enduml delimiters, curly quotes or non-breaking spaces pasted from word processors, and wrong arrow syntax for the diagram type. The troubleshooting guides in references/troubleshooting document 215+ such errors with fixes.