Skip to content

A command line utility to generate stuff with and for PlantUML.

License

Notifications You must be signed in to change notification settings

tmorin/plantuml-generator

Repository files navigation

plantuml-generator

Docker Image Version (latest semver)

A command line utility to generate stuff with and for PlantUML.

Introduction

plantuml-generator is a re-write of the crafted NodeJS app provided by tmorin/plantuml-libs. It provides commands to generate the stuff for PlantUML diagrams like library of PlantUML resources or just PlantUML diagrams rendering.

Dependencies

  • libssl-dev
  • java, version > 11
  • inkscape, version > 1.2
    • tested with Inkscape 1.2 (1:1.2.1+202207142221+cd75a1ee6d)
    • only required if used to generate a library

Install

By Script

curl -s "https://github.com/raw/tmorin/plantuml-generator/master/scripts/install_pgen.sh"  | bash

By Docker

docker run --rm thibaultmorin/plantuml-generator --help

By cargo

cargo install plantuml-generator

From the binaries available in the GitHub Release:

plantuml-generator --help

Commands

The tool provides the following commands:

  • library generate generates a PlantUML library based on a provided manifest
  • library schema Generate the JSON Schema of the library manifest
  • diagram generate generates .puml discovered recursively in the file system
  • workspace init generate a fresh workspace, i.e. a .pgen-workspace.yaml file
  • workspace install install an artifact in the workspace

Release

cargo install convco
cargo install cargo-release