README
¶
gopuml
gopuml is a CLI tool to compile Plant UML into images and links.
It has support for generating png, svg and txt output either as files or links. gopuml is built in golang and leverages plantuml.com to generate the output.
Example:
gopuml can convert this example text into an svg file or a link.
Plant UML
@startuml Example
Bob -> Alice : hello
@enduml
Generated SVG file
Generated SVG link
Table of Contents
Usage
Install
go install github.com/lonnblad/gopuml/cmd/gopuml@v0.2.0
Compiling UML
The command used to compile the Plant UML to different formats.
gopuml build [files]
To test the build feature in the gopuml repository:
gopuml build example/example.puml
Options
-
-f, --format
The format to use when compiling the Plant UML, defaults to:
svg.Supported formatters are:
png, will format the content as .pngsvg, will format the content as .svgtxt, will format the content as .txt
-
--server
The Server URL to use when the style used is
link, defaults to:https://www.plantuml.com/plantuml. -
--style
The style to use when compiling the Plant UML, defaults to:
file.Supported styles are:
file, will write the formatted content to a filelink, will write a link to the formatted content to stdoutout, will write the formatted content to stdout
Development Environment
gopuml supports running a local webserver which will automatically reload the rendered version of the Plant UML as they are updated
gopuml serve [files]
To test the serve feature in the gopuml repository:
gopuml serve example/example.puml
Options
- -p, --port
The port to use to serve the HTML page, defaults to: 8080.
Examples
These examples can be found here.
example.puml
The source Plant UML.
@startuml Example
Bob -> Alice : hello
@enduml
Compile files
Compiles example.png.
gopuml build -f png example/example.puml
Compiles example.svg.
gopuml build -f svg example/example.puml
Compiles example.txt.
gopuml build -f txt example/example.puml
┌───┐ ┌─────┐
│Bob│ │Alice│
└─┬─┘ └──┬──┘
│ hello │
│──────────────>│
┌─┴─┐ ┌──┴──┐
│Bob│ │Alice│
└───┘ └─────┘
Generate links
Generates a link for the example.png.
gopuml build -f png --style link example/example.puml
Generates a link for the example.svg.
gopuml build -f svg --style link example/example.puml
Generates a link for the example.txt.
gopuml build -f txt --style link example/example.puml
Documentation
¶
Overview ¶
Package gopuml have utility functions for compression and encoding according to: https://plantuml.com/text-encoding
Examples ¶
An example where the raw content of a file is compressed and encoded.
rawContent, err := os.ReadFile(pumlFilepath) ... compressed, err := gopuml.Deflate(rawContent) ... encoded := gopuml.Encode(compressed)
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
This section is empty.
Source Files
Directories
