Command-line interface usage#

Main command#

Aliases : qdt, qgis-deployment-toolbelt, qdeploy-toolbelt

Commands and options#

QGIS Deployment Toolbelt 0.31.1 - QGIS deployment toolbelt is a CLI (Command Line Interface) to perform redundant operations after a QGIS deployment.

qgis-deployment-toolbelt [-h] [--no-logfile] [--version] [-v] [--proxy-http QDT_PROXY_HTTP]
                         {deploy,upgrade,auto-update,update} ...

qgis-deployment-toolbelt options#

  • -h, --help - show this help message and exit

  • --no-logfile - Disable log file. Log files are usually created, rotated and stored in thefolder set by QDT_LOGS_DIR.

  • --version - Display CLI version

  • -v, --verbose - Verbosity level. None = WARNING, -v = INFO, -vv = DEBUG. Can be set with QDT_LOGS_LEVEL environment variable and logs location with QDT_LOGS_DIR. (default: 1)

  • --proxy-http QDT_PROXY_HTTP - Option to specify an HTTP proxy in the form: scheme://[user:passwd@]proxy.server:port (default: None)

deployment#

QDT’s main logic: run the deployment’s scenario.

deployment [-h] [-v] [--proxy-http QDT_PROXY_HTTP] [-s SCENARIO_FILEPATH]
deployment options#
  • -h, --help - show this help message and exit

  • -v, --verbose - Verbosity level. None = WARNING, -v = INFO, -vv = DEBUG. Can be set with QDT_LOGS_LEVEL environment variable and logs location with QDT_LOGS_DIR. (default: 1)

  • --proxy-http QDT_PROXY_HTTP - Option to specify an HTTP proxy in the form: scheme://[user:passwd@]proxy.server:port (default: None)

  • -s SCENARIO_FILEPATH, --scenario SCENARIO_FILEPATH - Scenario path, local or remote (HTTP/S). (default: scenario.qdt.yml)

upgrade (auto-update, update)#

Check if a new version of QDT is available and download it locally.

upgrade [-h] [-v] [--proxy-http QDT_PROXY_HTTP] [-c] [-n] [-w LOCAL_DOWNLOAD_FOLDER]
upgrade options#
  • -h, --help - show this help message and exit

  • -v, --verbose - Verbosity level. None = WARNING, -v = INFO, -vv = DEBUG. Can be set with QDT_LOGS_LEVEL environment variable and logs location with QDT_LOGS_DIR. (default: 1)

  • --proxy-http QDT_PROXY_HTTP - Option to specify an HTTP proxy in the form: scheme://[user:passwd@]proxy.server:port (default: None)

  • -c, --check-only - Only check if a new version is available. No download.

  • -n, --dont-show-release-notes - Display release notes.

  • -w LOCAL_DOWNLOAD_FOLDER, --where LOCAL_DOWNLOAD_FOLDER - Folder to store the downloaded file. (default: ./)

Developed by: Julien Moura (Oslandia), Vincent Bré (Oslandia)
Documentation: https://guts.github.io/qgis-deployment-cli/