PLANTUML(1)
π PLANTUML π
okay bestie so this is the manual page for PlantUML, version 1.2026.2 / unknown, and the build timestamp on it is literally 2026-02-28 22:22:28 UTC. yes that's a whole lot of numbers, i know. stay with me π«Ά
β¨ NAME β¨
PlantUML β the manual page for PlantUML version 1.2026.2 / unknown [2026-02-28 22:22:28 UTC]. that's the vibe. no cap.
πΈ DESCRIPTION πΈ
plantuml β generate diagrams from plain text. that's it. that's the whole personality. diagrams. from text. iconic π
π Usage
java -jar plantuml.jar [options] [file|dir]... java -jar
plantuml.jar [options] --gui
π¦ Description (yes, again, but this one is the real one)
so what it actually does: it processes PlantUML sources from files, from directories (optionally recursively, ooh), or from stdin via -pipe. love that for us.
π Wildcards (for files/dirs)
*β any characters except/and\?β exactly one character except/and\**β any characters across directories (recursive, she goes deep π)
Tip: quote your patterns to avoid shell expansion (e.g., "**/*.puml"). the shell will absolutely snatch your globs if you don't, and you'll be sitting there like π
π General:
π General:
--authorβ show information about PlantUML authors (give credit where it's due, bestie π)--check-graphvizβ check the Graphviz installation--dark-modeβ render diagrams in dark mode π€-d,--define <VAR>=<value>β define a preprocessing variable (equivalent to!define <var> <value>)--durationβ print total processing time β±οΈ--guiβ launch the graphical user interface-h,--helpβ show help and usage information--help-moreβ show extended help (advanced options, for the girlies who want more)--http-server[:<port>]β start the internal HTTP server for rendering (default port:8080)-p,--pipeβ read source from stdin, write result to stdout (the classic pipe moment)--progress-barβ show a textual progress bar--splash-screenβ show splash screen with progress bar-v,--verboseβ enable verbose logging (she's chatty, we love her)--versionβ show PlantUML and Java version
π₯ Execution control:
--check-before-runβ pre-check syntax of all inputs and stop faster on error--check-syntaxβ check diagram syntax without generating images--no-error-imageβ do not generate error images for diagrams with syntax errors--stop-on-errorβ stop at the first syntax error (no mercy π)
π§ Metadata & assets:
--extract-sourceβ extract embedded PlantUML source from PNG or SVG metadata--skip-freshβ skip PNG/SVG files that are already up-to-date (using metadata)--sprite <4|8|16[z]> <file>β encode a sprite definition from an image file
β Output format (choose one):
-f,--format <name>β set the output format for generated diagrams (e.g.png,svg,pdf,eps,latex,txt,utxt,obfuscate,preproc...)
πΈ Available formats:
--epsβ generate images in EPS format--latexβ generate LaTeX/TikZ output--obfuscateβ replace text in diagrams with obfuscated strings to share diagrams safely--pngβ generate PNG images (default, she's the main character π)--preprocβ generate the preprocessed source after applying!include,!define... (no rendering)--svgβ generate SVG images--txtβ generate ASCII art diagrams--utxtβ generate ASCII art diagrams using Unicode characters (fancy β¨)
π EXAMPLES π
okay these are the real ones, copied exactly, no editing, go off:
# Process all .puml recursively java -jar plantuml.jar
"**/*.puml"
# Check syntax only (CI) java -jar plantuml.jar --check-syntax
src/diagrams
# Read from stdin and write to stdout (SVG) cat diagram.puml |
java -jar plantuml.jar --svg -pipe > out.svg
# Encode a sprite from an image java -jar plantuml.jar --sprite
16z myicon.png
# Use a define java -jar plantuml.jar -DAUTHOR=John diagram.puml
# Change output directory java -jar plantuml.jar --format svg
--output-dir out diagrams/
π Exit codes:
0β success π50β no file found100β no diagram found in file(s)200β some diagrams have syntax errors π
π¦ See also:
java -jar plantuml.jar --help-more
Documentation: https://plantuml.com
(GPL source distribution) β yes she's open source, we stan π
π the little details at the bottom (iykyk)
- Build Version:
1.2026.2 - Git Commit:
unknown - Compile Time:
2026-02-28 22:22:28 UTC - Java Runtime:
OpenJDK Runtime Environment - JVM:
OpenJDK 64-Bit Server VM - Default Encoding:
ANSI_X3.4-1968 - Language:
en - Country:
US PLANTUML_LIMIT_SIZE:4096
Error:Dot executable does not existError:only sequence diagrams will be generated
like... graphviz said "not today" and now you only get sequence diagrams. tragic but forewarned π«Ά
okay that's the whole page, bestie. PlantUML version 1.2026.2 / u..., dated February 2026, page PLANTUML(1) β go make some diagrams, slay, periodt π
β¨π
π¦ where this page comes from
- epel 9: plantuml 1:1.2026.2-1.el9 Β· LGPL-3.0-or-later
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms