To use the Docker container, you should first ensure that you have installed Docker on your computer.

For the container we will use, we currently provide a container hosted at singularityhub/container-tree that you can use to quickly use the python module without any installation of other dependencies or compiling on your host.

When you are ready, try running containertree using it. This first command will shell you inside the container to use python interactively:

$ docker run singularityhub/container-tree

ContainerTree v0.0.43
usage: containertree [-h] [--debug] [--quiet] [--version]
                     {templates,generate} ...

ContainerTrees in Python

optional arguments:
  -h, --help            show this help message and exit
  --debug               use verbose logging to debug.
  --quiet               suppress additional output.
  --version             print version and exit.

  actions for ContainerTree Python

  {templates,generate}  containertree actions
    templates           View available tree templates
    generate            Generate a container tree.

It might also be desired to shell into the container (bash)

$ docker run -it --entrypoint bash singularityhub/container-tree 

This is the Docker container that drives Github Actions to generate container trees for your Github pages. See the example.