Command-line interface usage¶

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

Commands and options¶

QGIS Deployment Toolbelt 0.40.1.dev104+g0e3198d67.d20260407 - QGIS Deployment Toolbelt (QDT) is a CLI (Command Line Interface) to perform redundant operations after a QGIS deployment, managing QGIS profiles, plugins, environment variables, start menu / desktop shortcuts and many things to rationalize your QGIS installations.

qgis-deployment-toolbelt [-h] [--no-logfile] [--version] [-v] [--proxy-http QDT_PROXY_HTTP]
                         [--logs-filename QDT_LOGS_FILENAME] [--logs-dir QDT_LOGS_DIR]
                         {deploy,export-rules-context,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
--logs-filename QDT_LOGS_FILENAME - Option to specify a QDT log filename. Can also be defined with the environment variable 'QDT_LOGS_FILENAME'. Defaults to 'QGISDeploymentToolbelt_0.40.1.log'. (default: QGISDeploymentToolbelt_0.40.1.log)
--logs-dir QDT_LOGS_DIR - Option to specify a QDT log directory. Can be defined with the environment variable 'QDT_LOGS_DIR'. Defaults to ~/.cache/qgis-deployment-toolbelt/logs’. (default: /home/runner/.cache/qgis-deployment-toolbelt/logs)

qgis-deployment-toolbelt deploy¶

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

qgis-deployment-toolbelt deploy [-h] [-v] [--proxy-http QDT_PROXY_HTTP]
                                [--logs-filename QDT_LOGS_FILENAME] [--logs-dir QDT_LOGS_DIR]
                                [-s SCENARIO_FILEPATH]

qgis-deployment-toolbelt deploy 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
--logs-filename QDT_LOGS_FILENAME - Option to specify a QDT log filename. Can also be defined with the environment variable 'QDT_LOGS_FILENAME'. Defaults to 'QGISDeploymentToolbelt_0.40.1.log'. (default: QGISDeploymentToolbelt_0.40.1.log)
--logs-dir QDT_LOGS_DIR - Option to specify a QDT log directory. Can be defined with the environment variable 'QDT_LOGS_DIR'. Defaults to ~/.cache/qgis-deployment-toolbelt/logs’. (default: /home/runner/.cache/qgis-deployment-toolbelt/logs)
-s SCENARIO_FILEPATH, --scenario SCENARIO_FILEPATH - Scenario path, local or remote (HTTP/S). (default: scenario.qdt.yml)

qgis-deployment-toolbelt export-rules-context¶

Export QDT rules context taking into account the local environment to help rules writing.

qgis-deployment-toolbelt export-rules-context [-h] [-v] [--proxy-http QDT_PROXY_HTTP]
                                              [--logs-filename QDT_LOGS_FILENAME]
                                              [--logs-dir QDT_LOGS_DIR] [-o OUTPUT_PATH]

qgis-deployment-toolbelt export-rules-context 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
--logs-filename QDT_LOGS_FILENAME - Option to specify a QDT log filename. Can also be defined with the environment variable 'QDT_LOGS_FILENAME'. Defaults to 'QGISDeploymentToolbelt_0.40.1.log'. (default: QGISDeploymentToolbelt_0.40.1.log)
--logs-dir QDT_LOGS_DIR - Option to specify a QDT log directory. Can be defined with the environment variable 'QDT_LOGS_DIR'. Defaults to ~/.cache/qgis-deployment-toolbelt/logs’. (default: /home/runner/.cache/qgis-deployment-toolbelt/logs)
-o OUTPUT_PATH, --output OUTPUT_PATH - Path to the output file where to write rules context. (default: /home/runner/.cache/qgis-deployment-toolbelt/export/qdt_rules_context.json)

qgis-deployment-toolbelt upgrade (auto-update, update)¶

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

qgis-deployment-toolbelt upgrade [-h] [-v] [--proxy-http QDT_PROXY_HTTP]
                                 [--logs-filename QDT_LOGS_FILENAME]
                                 [--logs-dir QDT_LOGS_DIR] [-c] [-n]
                                 [-w LOCAL_DOWNLOAD_FOLDER]

qgis-deployment-toolbelt 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
--logs-filename QDT_LOGS_FILENAME - Option to specify a QDT log filename. Can also be defined with the environment variable 'QDT_LOGS_FILENAME'. Defaults to 'QGISDeploymentToolbelt_0.40.1.log'. (default: QGISDeploymentToolbelt_0.40.1.log)
--logs-dir QDT_LOGS_DIR - Option to specify a QDT log directory. Can be defined with the environment variable 'QDT_LOGS_DIR'. Defaults to ~/.cache/qgis-deployment-toolbelt/logs’. (default: /home/runner/.cache/qgis-deployment-toolbelt/logs)
-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: ./)