README.md

🚧 PlantUml CLI container 🚧

⚠️ It is not ready for general use ⚠️

Container base on eclipse-temurin:17-jre-jammy container.

• PLANTUML_VERSION: snapshot (23 mars 2023)

Usage

1. Install docker

2. Download the image

docker pull plantuml/plantuml-cli:latest

3. Run PlantUML

3.1. Go into the directory where your diagrams are

⚠️ Replace MY_DIRECTORY with your working directory.

cd MY_DIRECTORY

3.2. Execute PlantUML

# replace your_diagram_file.puml with the file name of your diagram.
docker run --rm -it \
           --volume "$PWD":/wd \
           --workdir /wd \
          plantuml/plantuml-cli:latest your_diagram_file.puml

💡 Tips: you can use a wrapper like this Bash script wrapper.

Enjoy 🥳

Contributing

Clone this repository

gh repo clone plantuml/docker
cd docker/plantuml-cli

Testing

1. Build the container

   make build

2. Run tests to validate that the container is working as expected

   make test

Debugging

You can use make enter to run a bash shell inside the container.