Skip to content
Back to search

plantuml

Generate diagrams from textual description

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/plantuml/plantuml with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/plantuml/plantuml'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/plantuml--plantuml/badge.svg)](/listings/plantuml--plantuml)

HTML

<a href="/listings/plantuml--plantuml"><img src="/api/listings/plantuml--plantuml/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 159 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. > [!NOTE]
  2. > 🛡️ **Security:** is PlantUML affected by a recent CVE? See [CVE.md](CVE.md) for the advisories we have checked and why PlantUML is not impacted.
  3. > [!TIP]
  4. > 🧩 **New!** Render PlantUML diagrams directly inside GitHub with [our official browser extension](https://github.com/plantuml/plantuml-for-github) &mdash; No server. No tokens. No tracking. Zero permissions but clipboard.
  5. >
  6. > [![Add to Chrome](https://img.shields.io/badge/Add%20to%20Chrome-4285F4?style=flat-square&logo=googlechrome&logoColor=white)](https://chromewebstore.google.com/detail/plantuml-for-github/lbokhidfopkdehkmlmpaabacljoediic) [![Add to Firefox](https://img.shields.io/badge/Add%20to%20Firefox-FF7139?style=flat-square&logo=firefoxbrowser&logoColor=white)](https://addons.mozilla.org/en-US/firefox/addon/plantuml-for-github/)
  7. >
  8. > 💬 Want native PlantUML support in GitHub? Upvote and join the discussion: [Support for PlantUML diagrams](https://github.com/orgs/community/discussions/10111)
  9. > [!TIP]
  10. > 🤖 **New!** Give your AI assistant the power to render and check PlantUML diagrams with [`@plantuml/mcp-js`](https://www.npmjs.com/package/@plantuml/mcp-js) &mdash; a pure Node.js [MCP](https://modelcontextprotocol.io/) server. No Java. No server. Just `npx @plantuml/mcp-js`.
  11. >
  12. > [![npm version](https://img.shields.io/npm/v/@plantuml/mcp-js?logo=npm&color=cb3837)](https://www.npmjs.com/package/@plantuml/mcp-js) [![npm downloads](https://img.shields.io/npm/dm/@plantuml/mcp-js?logo=npm&color=cb3837)](https://www.npmjs.com/package/@plantuml/mcp-js) [![MCP Toplist](https://mcptoplist.com/badge/glama%2Fplantuml.svg)](https://mcptoplist.com/server/glama%2Fplantuml)
  13. # 🌱 PlantUML
  14. Generate UML diagrams from textual descriptions.
  15. [![Discord server](https://img.shields.io/discord/1083727021328306236?color=5865F2&logo=discord&logoColor=white)](https://discord.gg/sXhzexAQGh)
  16. [![GitHub Sponsors](https://img.shields.io/github/sponsors/plantuml?logo=github)](https://github.com/sponsors/plantuml/)
  17. [![GitHub Org's stars](https://img.shields.io/github/stars/plantuml)](https://github.com/plantuml/plantuml/stargazers/)
  18. [![GitHub watchers](https://img.shields.io/github/watchers/plantuml/plantuml)](https://github.com/plantuml/plantuml/watchers/)
  19. [![GitHub contributors](https://img.shields.io/github/contributors-anon/plantuml/plantuml?color=blue)](https://github.com/plantuml/plantuml/graphs/contributors)
  20. [![GitHub forks](https://img.shields.io/github/forks/plantuml/plantuml)](https://github.com/plantuml/plantuml/network/)
  21. [![GitHub all releases](https://img.shields.io/sourceforge/dt/plantuml?color=blue)](https://github.com/plantuml/plantuml/releases)
  22. [![Release (latest by date)](https://img.shields.io/github/v/release/plantuml/plantuml)](https://github.com/plantuml/plantuml/releases/latest)
  23. [![Release Date](https://img.shields.io/github/release-date/plantuml/plantuml?color=blue)](https://github.com/plantuml/plantuml/releases/latest)
  24. [![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/plantuml/plantuml/latest)](https://github.com/plantuml/plantuml/commits/)
  25. [![javadoc](https://javadoc.io/badge2/net.sourceforge.plantuml/plantuml-gplv2/javadoc.svg)](https://javadoc.io/doc/net.sourceforge.plantuml/plantuml-gplv2)
  26. [![Pre-release (latest by date)](https://img.shields.io/github/v/release/plantuml/plantuml?color=chocolate&include_prereleases)](https://github.com/plantuml/plantuml/releases/tag/snapshot)
  27. [![Pre-release Date](https://img.shields.io/github/release-date-pre/plantuml/plantuml?color=chocolate)](https://github.com/plantuml/plantuml/releases/tag/snapshot)
  28. [![GitHub last commit](https://img.shields.io/github/last-commit/plantuml/plantuml?color=chocolate)](https://github.com/plantuml/plantuml/commits/)
  29. [![CI](https://github.com/plantuml/plantuml/actions/workflows/ci.yml/badge.svg?color=chocolate)](https://github.com/plantuml/plantuml/actions/workflows/ci.yml)
  30. [![snapshot javadoc](https://img.shields.io/badge/javadoc-snapshot-chocolate.svg?logo=github)](https://plantuml.github.io/plantuml/javadoc)
  31. [![snapshot jacoco](https://img.shields.io/badge/code_coverage%3A_jacoco-snapshot-chocolate?logo=github)](https://plantuml.github.io/plantuml/jacoco/test/html/index.html)
  32. [![SonarQube Cloud](https://img.shields.io/badge/scanned_on-SonarQube-blue?logo=sonarqubecloud)](https://sonarcloud.io/project/overview?id=plantuml_plantuml)
  33. [![Dev Project Pages index](https://img.shields.io/badge/dev_project-pages-764ba2?logo=github)](https://plantuml.github.io/plantuml/)
  34. [![Ask DeepWiki](https://img.shields.io/badge/Ask-DeepWiki-blue)](https://deepwiki.com/plantuml/plantuml)
  35. [![JavaScript Demo](https://img.shields.io/badge/JavaScript_PlantUML_Demo-F7DF1E?logo=javascript&logoColor=000)](https://plantuml.github.io/plantuml/js-plantuml)
  36. ## ℹ️ About
  37. 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.
  38. ### 🗃️ Supported Diagram Types
  39. - 🧩 UML Diagrams
  40. - [Sequence diagram](http://plantuml.com/sequence-diagram)
  41. - [Use case diagram](http://plantuml.com/use-case-diagram)
  42. - [Class diagram](http://plantuml.com/class-diagram)
  43. - [Object diagram](http://plantuml.com/object-diagram)
  44. - [Activity diagram](http://plantuml.com/activity-diagram-beta)
  45. - [Legacy syntax](http://plantuml.com/activity-diagram-legacy)
  46. - [Component diagram](http://plantuml.com/component-diagram)
  47. - [Deployment diagram](http://plantuml.com/deployment-diagram)
  48. - [State diagram](http://plantuml.com/state-diagram)
  49. - [Timing diagram](http://plantuml.com/timing-diagram)
  50. - 📈 Non-UML Diagrams
  51. - [JSON (JavaScript Object Notation) data](http://plantuml.com/json)
  52. - [YAML (YAML Ain't Markup Language) data](http://plantuml.com/yaml)
  53. - [EBNF (Extended Backus-Naur Form)](http://plantuml.com/ebnf)
  54. - [Regex (Regular Expression)](http://plantuml.com/regex)
  55. - [Network diagram (nwdiag)](http://plantuml.com/nwdiag)
  56. - [Salt (Wireframe graphical interface or UI Mockups)](http://plantuml.com/salt)
  57. - [Archimate diagram](http://plantuml.com/archimate-diagram)
  58. - [SDL (Specification and Description Language)](http://plantuml.com/activity-diagram-beta#sdl)
  59. - [Ditaa diagram](http://plantuml.com/ditaa)
  60. - [Gantt diagram](http://plantuml.com/gantt-diagram)
  61. - [Chronology diagram](http://plantuml.com/chronology-diagram)
  62. - [MindMap diagram](http://plantuml.com/mindmap-diagram)
  63. - [WBS (Work Breakdown Structure)](http://plantuml.com/wbs-diagram)
  64. - [Mathematical Notations (AsciiMath, JLaTeXMath)](http://plantuml.com/ascii-math)
  65. - Entity Relationship (ER) diagram
  66. - [Information Engineering (IE) diagram](http://plantuml.com/ie-diagram)
  67. - [Entity Relationship (ER) diagram (Chen's notation)](http://plantuml.com/er-diagram)
  68. - [Chart diagram](http://plantuml.com/chart-diagram)
  69. - [Files (files tree) diagram](http://plantuml.com/files-diagram)
  70. ### 📣 Additional Features
  71. - [Hyperlinks and tooltips](http://plantuml.com/link)
  72. - [Rich text (Creole) with emoticons, unicode, and icons](http://plantuml.com/creole)
  73. - [OpenIconic icons](http://plantuml.com/openiconic)
  74. - [Sprite icons](http://plantuml.com/sprite)
  75. ### 📖 Learn More
  76. For a more detailed overview, visit [PlantUML Official Website](https://plantuml.com/).
  77. ## 🛡 Security
  78. See [Security Policy](docs/SECURITY.md) and [Security overview](https://github.com/plantuml/plantuml/security).
  79. > [!IMPORTANT]
  80. > [PlantUML is **not** affected by the log4j vulnerability.](https://github.com/plantuml/plantuml/issues/826)
  81. ## 🚀 Getting Started
  82. 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](https://plantuml.com/starting) for instructions on how to set up PlantUML on your system.
  83. ## ⚙️ Building from Source
  84. To build PlantUML from source, you have two options:
  85. 1. Using Gradle: `./gradlew jar`
  86. 2. Using Ant: `ant`
  87. For prerequisites and detailed build instructions, see our [BUILDING.md](https://github.com/plantuml/plantuml/blob/master/docs/BUILDING.md) guide.
  88. ### 🌐 Building for the Browser (TeaVM)
  89. PlantUML can be compiled to JavaScript with [TeaVM](https://teavm.org/) to run entirely client-side in the browser, with no server required. To produce the JavaScript artifacts and use them in your own project:
  90. ```sh
  91. git clone https://github.com/plantuml/plantuml.git
  92. cd plantuml
  93. chmod +x ./gradlew
  94. ./gradlew clean teavm -Pfast
  95. cp ./build/generated/teavm/js/plantuml.js $YOUR_PROJECT/plantuml.js
  96. cp ./build/generated/teavm/js/viz-global.js $YOUR_PROJECT/viz-global.js
  97. ```
  98. 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](https://github.com/mdaines/viz-js) (Graphviz) support for diagrams that rely on Dot layout.
  99. The `teavm` task also copies the PlantUML stdlib bundles and a ready-to-use `index.html` demo into `./build/generated/teavm/js/`.
  100. For a live example of client-side rendering, see the [JavaScript PlantUML Demo](https://plantuml.github.io/plantuml/js-plantuml).
  101. ## 🧱 Contributing
  102. 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](CONTRIBUTING.md) for more information on how to get started.
  103. The language guide on [plantuml.com](https://plantuml.com) is updated through [alphadoc](http://alphadoc.plantuml.com/). Edit a page there (pick a language and wiki syntax), save, and maintainers publish it after review. Details are in [CONTRIBUTING.md](CONTRIBUTING.md#updating-the-plantuml-guide-alphadoc).
  104. For comprehensive and detailed documentation on using PlantUML, refer to the [official Javadoc, available here](https://plantuml.github.io/plantuml/javadoc). Please note that this documentation is a work in progress and may not be complete.
  105. ## 🧑‍🤝‍🧑 Support and Community
  106. - [GitHub issues](https://github.com/plantuml/plantuml/issues/)
  107. - [Community Forum](https://forum.plantuml.net/)
  108. ## 📃 License
  109. PlantUML is licensed under several licenses; you can choose the one that suits you best:
  110. - [GPL license](https://www.gnu.org/licenses/gpl-3.0.html)
  111. - [LGPL license](https://www.gnu.org/licenses/lgpl-3.0.html)
  112. - [Apache license](https://www.apache.org/licenses/LICENSE-2.0)
  113. - [Eclipse Public license](https://www.eclipse.org/legal/epl-2.0/)
  114. - [MIT license](https://opensource.org/licenses/MIT)
  115. For more information, please refer to the [PlantUML license FAQ](https://plantuml.com/en/faq#ddbc9d04378ee462) to help determine which license is appropriate for your use case.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.