Skip to content

Quick Start

Installing

QuickZip can be installed with pip. As to not pollute your system python, it is recommended to install this in a virtual environment or with a tool like pipx

$ pip install quick-zip

---> 100%

Setup

Before you get started there are a few things you might want to do

Optional

Specify a default config.toml file. This is specified with the full-path to the config.toml file on our file system using the QUICKZIP_CONFIG env variable. Note that if this is not set, you must pass the path to the config.toml file when call quick-zip run. See the Config File page for a template and more details on the configuration template.

Running

$ qz --help

Usage: qz [OPTIONS] COMMAND [ARGS]...

Options:
  --version
  --install-completion [bash|zsh|fish|powershell|pwsh]
                                  Install completion for the specified shell.
  --show-completion [bash|zsh|fish|powershell|pwsh]
                                  Show completion for the specified shell, to
                                  copy it or customize the installation.

  --help                          Show this message and exit.

Commands:
  audit   🧐 Performs ONLY the audits for configured jobs
  config  📄 displays the configuration file
  docs    💬 Opens quickZip documentation in browser
  jobs    🚧 Under construction...
  run     ✨ The main entrypoint for the application.