plantuml/plantuml

[!TIP] 🧩 New! Render PlantUML diagrams directly inside GitHub with our official browser extension — No server. No tokens. No tracking. Zero permissions but clipboard.

💬 Want native PlantUML support in GitHub? Upvote and join the discussion: Support for PlantUML diagrams

[!TIP] 🤖 New! Give your AI assistant the power to render and check PlantUML diagrams with @plantuml/mcp-js — a pure Node.js MCP server. No Java. No server. Just npx @plantuml/mcp-js.

🌱 PlantUML

Generate UML diagrams from textual descriptions.

ℹ️ About

PlantUML is a component that allows you to create various UML diagrams through simple textual descriptions. From sequence diagrams to deployment diagrams and beyond, PlantUML provides an easy way to create visual representations of complex systems.

🗃️ Supported Diagram Types

• 🧩 UML Diagrams
  • Sequence diagram
  • Use case diagram
  • Class diagram
  • Object diagram
  • Activity diagram
    • Legacy syntax
  • Component diagram
  • Deployment diagram
  • State diagram
  • Timing diagram
• 📈 Non-UML Diagrams
  • JSON (JavaScript Object Notation) data
  • YAML (YAML Ain't Markup Language) data
  • EBNF (Extended Backus-Naur Form)
  • Regex (Regular Expression)
  • Network diagram (nwdiag)
  • Salt (Wireframe graphical interface or UI Mockups)
  • Archimate diagram
  • SDL (Specification and Description Language)
  • Ditaa diagram
  • Gantt diagram
  • Chronology diagram
  • MindMap diagram
  • WBS (Work Breakdown Structure)
  • Mathematical Notations (AsciiMath, JLaTeXMath)
  • Entity Relationship (ER) diagram
    • Information Engineering (IE) diagram
    • Entity Relationship (ER) diagram (Chen's notation)
  • Chart diagram
  • Files (files tree) diagram

📣 Additional Features

• Hyperlinks and tooltips
• Rich text (Creole) with emoticons, unicode, and icons
• OpenIconic icons
• Sprite icons

📖 Learn More

For a more detailed overview, visit PlantUML Official Website.

🛡 Security

See Security Policy and Security overview.

[!IMPORTANT] PlantUML is not affected by the log4j vulnerability.

🚀 Getting Started

Whether you're looking to use PlantUML as a standalone application or as a component in your own project, getting started is simple. Check out the official PlantUML setup guide for instructions on how to set up PlantUML on your system.

⚙️ Building from Source

To build PlantUML from source, you have two options:

1. Using Gradle: ./gradlew jar
2. Using Ant: ant

For prerequisites and detailed build instructions, see our BUILDING.md guide.

🌐 Building for the Browser (TeaVM)

PlantUML can be compiled to JavaScript with TeaVM to run entirely client-side in the browser, with no server required. To produce the JavaScript artifacts and use them in your own project:

git clone https://github.com/plantuml/plantuml.git
cd plantuml
chmod +x ./gradlew
./gradlew clean teavm -Pfast
cp ./build/generated/teavm/js/plantuml.js $YOUR_PROJECT/plantuml.js
cp ./build/generated/teavm/js/viz-global.js $YOUR_PROJECT/viz-global.js

The -Pfast flag skips the slow parts of a regular build (tests, Javadoc, JaCoCo) so you only get the TeaVM output. The viz-global.js file provides Viz.js (Graphviz) support for diagrams that rely on Dot layout.

The teavm task also copies the PlantUML stdlib bundles and a ready-to-use index.html demo into ./build/generated/teavm/js/.

For a live example of client-side rendering, see the JavaScript PlantUML Demo.

🧱 Contributing

PlantUML is an open-source project, and we welcome contributions of all kinds. Whether you're helping us fix bugs, improve the docs, or spread the word, we appreciate your support. See our contributing guide for more information on how to get started.

For comprehensive and detailed documentation on using PlantUML, refer to the official Javadoc, available here. Please note that this documentation is a work in progress and may not be complete.

🧑‍🤝‍🧑 Support and Community

• GitHub issues
• Community Forum

📃 License

PlantUML is licensed under several licenses; you can choose the one that suits you best:

• GPL license
• LGPL license
• Apache license
• Eclipse Public license
• MIT license

For more information, please refer to the PlantUML license FAQ to help determine which license is appropriate for your use case.