Command-line Interface

qt-dev-helper

Collection of CLI commands to improve workflows when developing Qt GUI Applications.

qt-dev-helper [OPTIONS] COMMAND [ARGS]...

Options

--install-completion <install_completion>

Install completion for the specified shell.

Options:

bash | zsh | fish | powershell | pwsh

--show-completion <show_completion>

Show completion for the specified shell, to copy it or customize the installation.

Options:

bash | zsh | fish | powershell | pwsh

build

Build production assets from input files.

qt-dev-helper build [OPTIONS] [BASE_PATH]

Options

-c, --config <config>

Path to a config file.

-r, --recurse-folder

Recurse directories searching for files.

Default:

False

-g, --generator <generator>

Code generator used to compile ui and resource files.

Options:

python | cpp

--flatten-folder-structure, --no-flatten-folder-structure

Whether or not to flatten the folder structure of the ui and resource files.

--ui, --no-ui

Whether or not to build ui files from ‘*.ui’ files.

Default:

True

--ui-files-folder <ui_files_folder>

Root folder containing *.ui files.

--generated-ui-code-folder <generated_ui_code_folder>

Root folder to save code generated from *.ui files to.

--uic-args <uic_args>

Additional arguments for the uic executable, as comma separated list.

--rc, --no-rc

Whether or not to build resource files from ‘*.qrc’ files.

Default:

True

--resource-folder <resource_folder>

Root folder containing *.qrc files.

--generated-rc-code-folder <generated_rc_code_folder>

Root folder to save code generated from *.qrc files to.

--form-import, --no-form-import

Python: generate imports relative to ‘.’

--rcc-args <rcc_args>

Additional arguments for the rcc executable, as comma separated list.

--qss, --no-qss

Whether or not to build qss files from ‘*.scss’ files.

Default:

True

--root-sass-file <root_sass_file>

Scss stylesheet with the style for the whole application.

--root-qss-file <root_qss_file>

Qss stylesheet with the style for the whole application, generated from ‘root_sass_file’.

Arguments

BASE_PATH

Optional argument

designer

Open *.ui files in qt-designer.

qt-dev-helper designer [OPTIONS] [FILES]...

Options

--recurse-folder, --no-recurse-folder

Whether or not to recurse directories searching for files.

Default:

True

--open-files, --no-open-files

Whether or not to open files.

Default:

True

Arguments

FILES

Optional argument(s)