plantuml command

SYNOPSIS:
    Generates plantuml diagrams from puml files.

USAGE: plantuml [OPTIONS] [ARGUMENTS]
USAGE: plantuml [--help|-h] [--config]
  [--bash-framework-config <bash-framework-config>] [--verbose|-v] [-vv] [-vvv]
  [--log-level <log-level>] [--log-file <log-file>]
  [--display-level <display-level>] [--no-color] [--theme <theme>] [--version]
  [--quiet|-q] [--ci] [--format|-f <Format>] [--limit-size|-l <LimitSize>]
  [--same-dir] [--output-dir|-o <OutputDir>] [--include-paths <IncludePaths>]
  [--elk]

ARGUMENTS:
  [PlantumlFiles {list} (optional)]    Plantuml files (if not provided, deduce files
    from git repository with .puml extension)


GLOBAL OPTIONS:
  --help, -h {single}
    Displays this command help
  --config {single}
    Displays configuration
  --bash-framework-config <bash-framework-config> {single}
    Use alternate bash framework configuration.
  --verbose, -v {single}
    Info level verbose mode (alias of --display-level INFO)
  -vv {single}
    Debug level verbose mode (alias of --display-level DEBUG)
  -vvv {single}
    Trace level verbose mode (alias of --display-level TRACE)
  --log-level <log-level> {single}
    Set log level
    Possible values: 
      - OFF
      - ERR
      - ERROR
      - WARN
      - WARNING
      - INFO
      - DEBUG
      - TRACE
    Default value: OFF
  --log-file <log-file> {single}
    Set log file
    Default value: /bash/logs/plantuml.log
  --display-level <display-level> {single}
    Set display level
    Possible values: 
      - OFF
      - ERR
      - ERROR
      - WARN
      - WARNING
      - INFO
      - DEBUG
      - TRACE
    Default value: INFO
  --no-color {single}
    Produce monochrome output. alias of --theme noColor.
  --theme <theme> {single}
    Choose color theme - default-force means colors will be produced even if
    command is piped.
    Possible values: 
      - default
      - default-force
      - noColor
    Default value: default
  --version {single}
    Print version information and quit.
  --quiet, -q {single}
    Quiet mode, doesn't display any output.

OPTIONS:
  --ci {single}
    Activate continuous integration mode (tmp folder not shared with host)

  --format, -f <Format> {list} (optional)
    Defines output format of this command
    Possible values: 
      - svg
      - png
  --limit-size, -l <LimitSize> {single}
    Define PLANTUML_LIMIT_SIZE
    use plantuml software default size if not provided

    Default value: 0
  --same-dir {single}
    Write image file in same directory as source file
    and with the same base name (except extension)
    Incompatible with the option --output-dir

  --output-dir, -o <OutputDir> {single}
    Define output directory of this command (default: <currentDirectory>)
    Incompatible with the option --same-dir

  --include-paths <IncludePaths> {single}
    Comma-separated list of paths to make shared inside docker container
    so that !include directives in plantuml files can work
    relative to these paths.

    Example: --include-paths "dir1,dir2,dir3"

    Each path will be validated for existence and mounted separately.
    If not provided, the current directory will be used as include path.

  --elk {single}
    Enable ELK (Eclipse Layout Kernel) support by downloading and
    mounting elk-full.jar. The jar is downloaded from
    http://beta.plantuml.net/elk-full.jar and cached in /tmp/bash-framework/
    bash-framework-1-1qqMcp/bash-framework/elk-full.jar. It will be re-downl
    oaded if older than 1 month.



DESCRIPTION:
Generates plantuml diagrams from puml files in formats provided

CHANGELOG

Version 3.3 (2026-04-09):

  - Fail if syntax error in plantuml file

  - restored metadata so files are not regenerated if plantuml
    file is not changed

PLANTUML HELP

docker was not available while generating this documentation

VERSION: 3.3

AUTHOR: [François Chastanet](https://github.com/fchastanet)

SOURCE FILE: https://github.com/fchastanet/bash-tools-framework/tree/master/src/_binaries/plantuml/plantuml-binary.yaml

LICENSE: MIT License
Copyright (c) 2023-now François Chastanet