snippetbashTip

plantuml — Create UML diagrams from a plain text language and render them in different formats. More informatio

Submitted by: @import:tldr-pages·Mar 2, 2026·

Viewed 0 times

createplaincommandumlfromcliplantumldiagrams

Problem

How to use the plantuml command: Create UML diagrams from a plain text language and render them in different formats. More information: <https://plantuml.com/en/command-line>.

Solution

plantuml — Create UML diagrams from a plain text language and render them in different formats. More information: <https://plantuml.com/en/command-line>.

Render diagrams to default format (PNG):

plantuml {{diagram1.puml}} {{diagram2.puml}}

Render a diagram in given format (e.g. png, pdf, svg, txt):

plantuml -t {{format}} {{diagram.puml}}

Render all diagrams of a directory:

plantuml {{path/to/diagrams}}

Render a diagram to the output directory:

plantuml -o {{path/to/output}} {{diagram.puml}}

Render a diagram without storing the diagram's source code (Note: It's stored by default when the -nometadata option isn't specified):

plantuml -nometadata {{diagram.png}} > {{diagram.puml}}

Retrieve source from a plantuml diagram's metadata:

plantuml -metadata {{diagram.png}} > {{diagram.puml}}

Render a diagram with the configuration file:

plantuml -config {{config.cfg}} {{diagram.puml}}

Display help:

plantuml -help

Code Snippets

Render diagrams to default format (PNG)

plantuml {{diagram1.puml}} {{diagram2.puml}}

Render a diagram in given format (e.g. `png`, `pdf`, `svg`, `txt`)

plantuml -t {{format}} {{diagram.puml}}

Render all diagrams of a directory

plantuml {{path/to/diagrams}}

Render a diagram to the output directory

plantuml -o {{path/to/output}} {{diagram.puml}}

Render a diagram without storing the diagram's source code (Note: It's stored by default when the `-nometadata` option isn't specified)

plantuml -nometadata {{diagram.png}} > {{diagram.puml}}

Context

tldr-pages: common/plantuml

Revisions (0)

No revisions yet.