Skip to content
BENIBIX Learn

PlantUML

Design🛠️ Design ToolsDiagram Tools

Also known as Plant UML, PlantUML Diagram, @startuml

A free tool that turns lines of text into UML diagrams. You write it, and it draws it.

Think of it like

It is like a note to a painter. You write what goes where, and the painter makes the picture.

Example

Lucy keeps a PlantUML sequence diagram of the checkout in her team's wiki. When the payment step changes, she edits one line and the picture redraws.

Why it matters

It draws strict UML from text, so the picture can live in Git and change with the code. Big teams use it to keep design pictures up to date.

Definition

PlantUML is an open-source tool that draws diagrams from plain text. You write lines between @startuml and @enduml, and it draws the picture. It covers the common UML diagrams, such as sequence, class, activity and state. It also draws mind maps, Gantt charts and network maps. It runs on Java, and many wikis and code editors can show its diagrams.

Example code

plantuml
@startuml
Emma -> Shop: Place order
Shop -> Bank: Take payment
Bank --> Shop: Paid
Shop --> Emma: Order confirmed
@enduml
Six lines of text. PlantUML draws four messages between Emma, the shop and the bank.
PlantUML is the text way on the right. You write the lines, and it lays out the boxes.

Common mistake

Expecting GitHub to draw it like Mermaid. GitHub does not show PlantUML in Markdown. You need a server, a plugin or a saved image.

Key takeaways

  1. 1
    Text in, picture out. Write between @startuml and @enduml.
  2. 2
    UML and more. Sequence, class, state, Gantt and more.
  3. 3
    Runs on Java. Draws on your machine or a server.

Compare

Learn it properly