[PlantUML](https://plantuml.com/) is a [[domain-specific language]] for creating [[diagrams]].
## Installation
See the instructions for installing PlantUML [here](https://plantuml.com/starting). You will need both [[Java]] and [[GraphViz]]. Download the `plantuml.jar` file from Source Forge [here](https://sourceforge.net/projects/plantuml/postdownload). You do not need to unpack or install anything.
Run (double-click) the `plantuml.jar` to open the GUI.
## Getting Started
Diagrams are written using PlantUML's DSL in text files. Copy the `plantuml.jar` file into the directory where the text files are stored. Run (double-click) the `plantuml.jar` file to open the GUI and view the diagrams.
To create your first diagram:
1. Create a new text file in the same directory as the `plantuml.jar` file and name it `sequenceDiagram.txt`.
2. Copy/paste the following text into the file:
```text
@startuml
Alice -> Bob: test
@enduml
```
3. Run (double-click) the `plantuml.jar` file. The file `sequenceDiagram.txt` should be listed in the window. Double-click to open.
## CLI
To create diagrams from the command line, run (or have your software call) PlantUML using a text file as input. The image will either be displayed in the software or saved as an image file on disk.
To create an image from the example `sequenceDiagram.txt`:
```bash
java -jar plantuml.jar sequenceDiagram.txt
```