Docker

./dep

A CLI tool to manage QFlex dependancies and images. (suggest running ./dep --show-completion >> ~/.bashrc && source ~/.bashrc to enable autocompletions)

Usage:

./dep [OPTIONS] COMMAND [ARGS]...

Options:

  --install-completion  Install completion for the current shell.
  --show-completion     Show completion for the current shell, to copy it or
                        customize the installation.
  --help                Show this message and exit.

build-docker

Build the Docker image for QFlex. Use --debug to build a debug version. Useful for development and testing without installing dependencies locally.

Usage:

./dep build-docker [OPTIONS]

Options:

  --debug / --no-debug          Build the Docker image in debug mode.
                                \[default: no-debug]
  --worm / --no-worm            Build the Docker image with WORM support.
                                Experimental  \[default: no-worm]
  --worm-only / --no-worm-only  Re-build only the WORMCache component.
                                \[default: no-worm-only]
  --push / --no-push            Push the built image to github container
                                registery. Requires authentication.
                                \[default: no-push]
  --help                        Show this message and exit.

start-docker

Start a Docker container with the QFlex environment. Useful for development and testing without installing dependencies locally.

Usage:

./dep start-docker [OPTIONS]

Options:

  --mounting-folder TEXT  Folder to mount for files.  \[required]
  --debug / --no-debug    Start the Docker container in debug mode.
                          \[default: no-debug]
  --worm / --no-worm      Build the Docker image with WORM support.
                          Experimental  \[default: no-worm]
  --help                  Show this message and exit.