The easiest way to test PlantUML is in an online solution that has PlantUML embedded, such as our
online server.
After testing, you may want to
install PlantUML locally.
You need these things to run PlantUML:
Installed the above? Then simply download
plantuml.jar and run it to open PlantUML's
graphical user interface. There is no need to unpack or install anything.
Use PlantUML's
command line syntax to
include it in your own scripts or documentation tools.
- Create a text file with PlantUML commands, like this example called
sequenceDiagram.txt
:
@startuml
Alice -> Bob: test
@enduml
2. Run (or have your software call) PlantUML, using
sequenceDiagram.txt
as input. The output is an image, which either appears in the other software, or is written to an image file on disk.
For example:
java -jar plantuml.jar sequenceDiagram.txt
This outputs your sequence diagram to a file called
sequenceDiagram.png
.