LinuxCommandLibrary

plantuml

Generate UML diagrams from text descriptions

TLDR

Generate diagram

$ plantuml [diagram.puml]
copy
Output as PNG
$ plantuml -tpng [diagram.puml]
copy
Output as SVG
$ plantuml -tsvg [diagram.puml]
copy
Output to directory
$ plantuml -o [output_dir] [diagram.puml]
copy
Read from stdin
$ echo "@startuml\nA -> B\n@enduml" | plantuml -pipe > [diagram.png]
copy
Watch for changes
$ plantuml -gui
copy

SYNOPSIS

plantuml [options] files...

DESCRIPTION

plantuml generates UML diagrams from text descriptions. It supports sequence diagrams, class diagrams, activity diagrams, and many other types.
The tool uses a simple text-based syntax that can be version-controlled and integrated into documentation workflows.

PARAMETERS

-t format

Output format (png, svg, eps, pdf, txt).
-o dir
Output directory.
-charset encoding
Input file encoding.
-pipe
Use stdin/stdout.
-gui
Launch GUI.
-config file
Include config file.
-checkversion
Check for updates.
-verbose
Verbose output.

DIAGRAM TYPES

Sequence, Class, Activity, Use Case, Component, State, Object, Deployment, Timing, Wireframe, Gantt, Mind Map

CAVEATS

Requires Java. Graphviz needed for some diagrams. Large diagrams may be slow. Complex layouts need tuning.

HISTORY

PlantUML was created by Arnaud Roques starting in 2009. It brought text-based diagramming to UML, integrating with wikis, documentation tools, and IDEs.

SEE ALSO

graphviz(1), mermaid(1), ditaa(1), drawio(1)

> TERMINAL_GEAR

Curated for the Linux community

Copied to clipboard

> TERMINAL_GEAR

Curated for the Linux community