Installation

Plantumlcli is currently hosted on PyPI. It required python >= 3.6.

You can simply install plantumlcli from PyPI with the following command:

pip install plantumlcli

You can also install with the newest version through GitHub:

pip install -U git+https://github.com/hansbug/plantumlcli.git@main

Note

If you need to export diagrams as PDF format, please install it using

pip install plantumlcli[pdf]

And make sure that your local Cairo environment is properly configured. See CairoSVG’s Documentation for more details.

You can check your installation by the following python script:

1
2
3
4
5
6
from plantumlcli.config.meta import __TITLE__, __AUTHOR__, __VERSION__, __DESCRIPTION__

if __name__ == '__main__':
    print(__TITLE__, __VERSION__)
    print('Developed and maintained by', __AUTHOR__)
    print(__DESCRIPTION__)

The output should be like below, which means your installation is successful.

1
2
3
plantumlcli 0.1.2
Developed and maintained by HansBug
An easy-to-use plantuml cli for everyone.

Plantumlcli is still under development, you can also check out the documents in stable version through https://hansbug.github.io/plantumlcli/.