Command-line interface usage¶

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

deploy¶

Running a scenario deployment.

usage: qdt deploy [-h] [-v] [--proxy-http QDT_PROXY_HTTP]
                  [--logs-filename QDT_LOGS_FILENAME]
                  [--logs-dir QDT_LOGS_DIR] [-s SCENARIO_FILEPATH]

Named Arguments¶

-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

Option to specify an HTTP proxy in the form: scheme://[user:passwd@]proxy.server:port

--logs-filename

Option to specify a QDT log filename. Can also be defined with the environment variable ‘QDT_LOGS_FILENAME’. Defaults to ‘QGISDeploymentToolbelt_0.44.1.log’.

Default: 'QGISDeploymentToolbelt_0.44.1.log'

--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

Scenario path, local or remote (HTTP/S).

Default: scenario.qdt.yml

Tip

This subcommand is defined as default. So qdt -s [...] is equivalent to qdt deploy -s [...]

cleanup¶

Remove stale resources related to previous deployments. Also usable as job.

usage: qdt cleanup [-h] [-v] [--proxy-http QDT_PROXY_HTTP]
                   [--logs-filename QDT_LOGS_FILENAME]
                   [--logs-dir QDT_LOGS_DIR]
                   [--deletion-policy {force_delete,trash_only,trash_or_delete}]
                   [--dry-run] [--scope {plugins_cache,plugins_installed}]

Named Arguments¶

-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

Option to specify an HTTP proxy in the form: scheme://[user:passwd@]proxy.server:port

--logs-filename

Option to specify a QDT log filename. Can also be defined with the environment variable ‘QDT_LOGS_FILENAME’. Defaults to ‘QGISDeploymentToolbelt_0.44.1.log’.

Default: 'QGISDeploymentToolbelt_0.44.1.log'

--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

--deletion-policy

Possible choices: force_delete, trash_only, trash_or_delete

Deletion policy applied to resources actually removed by this cleanup. Can also be set with the ‘QDT_DELETION_POLICY’ environment variable. Defaults to ‘trash_or_delete’.

Default: 'trash_or_delete'

--dry-run

Only display what would be removed, without deleting anything. Defaults to False.

Default: False

--scope

Possible choices: plugins_cache, plugins_installed

Scope of the cleanup. Repeat the option to combine several scopes. Defaults to ‘[‘plugins_cache’]’.

Default: ['plugins_cache']

export-rules-context¶

Export rules context in a JSON file.

usage: qdt export-rules-context [-h] [-v] [--proxy-http QDT_PROXY_HTTP]
                                [--logs-filename QDT_LOGS_FILENAME]
                                [--logs-dir QDT_LOGS_DIR] [-o OUTPUT_PATH]

Named Arguments¶

-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

Option to specify an HTTP proxy in the form: scheme://[user:passwd@]proxy.server:port

--logs-filename

Option to specify a QDT log filename. Can also be defined with the environment variable ‘QDT_LOGS_FILENAME’. Defaults to ‘QGISDeploymentToolbelt_0.44.1.log’.

Default: 'QGISDeploymentToolbelt_0.44.1.log'

--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 to the output file where to write rules context.

Default: /home/runner/.cache/qgis-deployment-toolbelt/export/qdt_rules_context.json

upgrade¶

Note

Look for the latest released version and compare it with the running one.

usage: qdt upgrade [-h] [-v] [--proxy-http QDT_PROXY_HTTP]
                   [--logs-filename QDT_LOGS_FILENAME]
                   [--logs-dir QDT_LOGS_DIR] [-c] [-n]
                   [-w LOCAL_DOWNLOAD_FOLDER]

Named Arguments¶

-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

Option to specify an HTTP proxy in the form: scheme://[user:passwd@]proxy.server:port

--logs-filename

Option to specify a QDT log filename. Can also be defined with the environment variable ‘QDT_LOGS_FILENAME’. Defaults to ‘QGISDeploymentToolbelt_0.44.1.log’.

Default: 'QGISDeploymentToolbelt_0.44.1.log'

--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.

Default: False

-n, --dont-show-release-notes

Display release notes.

Default: True

-w, --where

Folder to store the downloaded file.

Default: ./

completion¶

Print instructions on enabling shell completions for QDT.

If you encountered register-python-argcomplete command not found error, run:
pipx install 'qgis-deployment-toolbelt[completion]'
or if you already installed QDT with pipx:
pipx inject qgis-deployment-toolbelt argcomplete
Bash: typically add to ~/.bashrc or ~/.profile:
eval "$(register-python-argcomplete qdt)"
eval "$(register-python-argcomplete qgis-deployment-toolbelt)"
zsh: to activate completions in zsh, first make sure compinit is enabled:
autoload -U compinit && compinit
Afterwards you can enable completions:
eval "$(register-python-argcomplete qdt)"
fish:
register-python-argcomplete --shell fish qdt >~/.config/fish/completions/qdt.fish
Powershell 5+:
register-python-argcomplete --shell powershell qdt | Out-String | Invoke-Expression

Note

CLI autocompletions are not available in “frozen” binaries in official releases.

usage: qdt completion [-h]