Edit in DokuwikiEdit in AsciidocEdit in Markdown

Quick Start Guide to PlantUML

If you are keen to dive right in, the quickest way to try out PlantUML is through an online solution with embedded PlantUML support, such as our online server.

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Setting Up PlantUML Locally

Should you decide to set up a more permanent workspace after your initial test, consider proceeding with a local installation of PlantUML. To get started, ensure you have the following prerequisites installed:

• Java
• Graphviz (note: this is optional and only necessary if you intend to work with diagrams other than sequence diagrams and activity (beta) diagrams)

Once you have secured the prerequisites, download the plantuml.jar file and run it to access PlantUML’s graphical user interface. There's no need for any further unpacking or installation steps.

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Operating PlantUML from the Command Line

For those who prefer utilizing command line interfaces or wish to incorporate PlantUML into scripts or documentation tools, PlantUML provides a convenient command line syntax. Follow these simple steps to create a diagram from the command line:

1. Draft a text file containing PlantUML commands. Here’s a basic example titled sequenceDiagram.txt:

@startuml
Alice -> Bob: test
@enduml

2. Execute PlantUML using the text file as input. The command will process the input and generate an image as the output. This image can be integrated into other software or saved as an image file on your disk. Here is how you can do it:

java -jar plantuml.jar sequenceDiagram.txt

This command will produce a file named sequenceDiagram.png displaying your created sequence diagram.

Get started with PlantUML today and streamline your diagram creation process!