3 Star 2 Fork 1

HansBug / plantumlcli

Create your Gitee Account
Explore and code with more than 6 million developers,Free private repositories !:)
Sign up
Clone or download
Notice: Creating folder will generate an empty file .keep, because not support in Git


License Code Lint Code Test Coverage Status

An easy-to-use plantuml cli for everyone.


Install from official pypi

pip install plantumlcli

Install from source code

git clone https://github.com/HansBug/plantumlcli
cd plantumlcli && pip install .

Python 3.5+ is required, pypy is also tested to be okay.

Using with cli

Basic Usage

Show version of plantumlcli

plantumlcli -v

Show help information of plantumlcli

plantumlcli -h

Check the local plantuml environment and remote plantuml host

plantumlcli -c   # check both environments
plantumlcli -cL  # check local environment only
plantumlcli -cR  # check remote environment only

In default, no local plantuml jar can be used, the remote host is set to the official one (http://www.plantuml.com/plantuml). But don't worry, you can specify your plantuml jar file or remote host by environment variables or command lines.

plantumlcli -c                                             # local not okay, remote okay
PLANTUML_HOST=http://plantuml.example.com plantumlcli -cR  # remote okay
plantumlcli -cR -r http://plantuml.example.com             # remote okay
PLANTUML_JAR=/my/path/plantuml.jar plantumlcli -cL         # local okay
plantumlcli -cL -p /my/path/plantuml.jar                   # local okay

Build image from plantuml source code

plantumlcli source.puml                # the target image will be named as 'source.png'
plantumlcli -o image.png source.puml   # the target image will be named as 'image.png'
plantumlcli -t eps source.puml         # eps format is supported
plantumlcli source1.puml source2.puml  # 2 source codes, the images' names will be 'source1.png' and 'source2.png'
plantumlcli -o image1.png -o image2.png source1.puml source2.puml  # 2 source codes, image will be 'image1.png' and 'image2.png'

PLANTUML_JAR=/my/path/plantuml.jar plantumlcli source.puml     # use local plantuml jar to build png
PLANTUML_JAR=/my/path/plantuml.jar plantumlcli -L source.puml  # force use local plantuml jar to build png
PLANTUML_HOST=http://plantuml.example.com plantuml source.puml     # use your plantuml host to build png
PLANTUML_HOST=http://plantuml.example.com plantuml -R source.puml  # force use your plantuml host to build png

You can also get the URL address of remote plantuml (in these cases, remote plantuml will be used regardless of -L and -R commands)

plantumlcli -u helloworld.puml              # get png URL of helloworld.puml
plantumlcli -u -t eps helloworld.puml       # get eps URL of helloworld.puml
plantumlcli --homepage-url helloworld.puml  # get online editor's URL of helloworld.puml
plantumlcli -u helloworld.puml common.puml  # get png URL of the 2 puml files (one line for one URL, in order)

Using from python

You can also use plantumlcli in python source code by import

# environment variables
# PLANTUML_JAR=/path/to/plantuml.jar
# PLANTUML_HOST=https://plantuml.example.com

from pathlib import Path
from plantumlcli import LocalPlantuml, RemotePlantuml

if __name__ == "__main__":
    code = Path('source.puml').read_text()

    local = LocalPlantuml.autoload()
    print(local.dump_txt(code))                           # print text graph of code
    local.dump('/my/path/source_local.png', 'png', code)  # save png to /my/path/source_local.png
    local.dump('/my/path/source_local.eps', 'eps', code)  # save eps to /my/path/source_local.eps

    remote = RemotePlantuml.autoload()
    print(remote.dump_txt(code))                            # print text graph of code
    remote.dump('/my/path/source_remote.png', 'png', code)  # save png to /my/path/source_remote.png
    remote.dump('/my/path/source_remote.eps', 'eps', code)  # save eps to /my/path/source_remote.eps
    print(remote.get_url('png', code))                      # get png url from remote host
    print(remote.get_homepage_url(code))                    # get online editor's url from remote host


Thank you for considering contributing to plantumlcli!

The contribution guide will be completed soon after. (TODO: complete contribution guide)


Github: https://github.com/HansBug/plantumlcli

Documentation(just readme yet, will be written soon): https://github.com/HansBug/plantumlcli/blob/main/README.md

Issue Tracker: https://github.com/HansBug/plantumlcli/issues

Pypi: https://pypi.org/project/plantumlcli/

Test pypi(pre-released versions can be found here): https://test.pypi.org/project/plantumlcli/

Change log

Version 0.0.2

Released 2020-11-30

Version 0.0.1

Released 2020-11-29

  • The first official plantumlcli version, cheers!!! :beers:

Comments ( 0 )

Sign in for post a comment


Python cli and package interface for local and remote plantuml spread retract


No release

Gitee Metrics




load more
can not load any more


103611 48b8ff67 1899542 103622 4d02230c 1899542