To be able to generate some diagrams, you must have Graphviz software installed on your machine.
Important note about version
PlantUML should be working with any version of Graphviz, starting with 2.26.3
The following version have been tested, and are known to work:
However, it is possible that some cases with some versions have issues.
If you compile Graphviz by yourself, you have to build it with libexpat in order to work with PlantUML.
If you find something wrong, thanks for sending us a note or posting a message
on the question&answer page.
By default, the dot executable should be:
- Windows :
- Firstly in:
- Then in:
c:\Program Files (x86)\Graphviz*\bin\dot.exe
- On Linux/Mac OS-X :
- Firstly in:
- Then in:
Note for Mac users
You can easily install GraphViz by installing brew on your Mac machine.
This could fix issues if you have installed GraphViz as .dmg package.
brew install libtool
brew link libtool
brew install graphviz
brew link --overwrite graphviz
To have information about where PlantUML expects to find
dot, you can use the command line:
java -jar plantuml.jar -testdot
You can also use this special diagram description:
If you have installed somewhere else Graphviz, you will have to
define the environment variable
GRAPHVIZ_DOT to the exact
location of the dot program. Be carefull, the variable must contain an executable,
not a directory.
My Computer/Properties/Advanced/Environment Variables
GRAPHVIZ_DOT to your executable.
On Linux/Mac OS-X
setenv GRAPHVIZ_DOT /usr/local/bin/graphviz/dot
You can also define it as a Java Property, by changing some configuration
file, or using the -D flag in your java command line.
Another option is to use the -graphvizdot flag in the command line:
java -jar plantuml.jar -graphvizdot "d:/dummy/dot.exe" file1
You can also change the path of the dot executable in the Ant task:
<project name="OwnTaskExample" default="main" basedir=".">
<!-- task definition -->
<taskdef name="plantuml" classname="net.sourceforge.plantuml.ant.PlantumlTask" classpath="plantuml.jar" />
<!-- process ./src files -->
<plantuml dir="./src" graphvizDot="/path/dot" />
You should use the lastest version of Graphviz to generate your diagram.
Older version (older than 2.26.3 like for example 2.16) may not work.
If you want to test your version, you can download dottest.txt and stereo.png
and type the following command:
If an image is correctly generated, it means that your Graphviz/dot installation is fine.
dot -Tpng -otest.png dottest.txt