Command Line Options

The CLI uses argparse to parse the command line options so the short or long versions may be used and the long options may be truncated to the shortest unambiguous abbreviation.

Generic commands

aqt help

show generic help

aqt version

display version

List-* Commands

These commands are used to list the packages available for installation with aqt.

list-qt command

aqt list-qt [-h | --help]
            [--extension <extension>]
            [--spec <specification>]
            [--modules    (<Qt version> | latest) <architecture> |
             --extensions (<Qt version> | latest) |
             --arch       (<Qt version> | latest) |
             --archives   (<Qt version> | latest) architecture [modules...]
             --latest-version]
            <host> [<target>]

List available versions of Qt, targets, extensions, modules, and architectures.

host: linux, windows or mac

target: desktop, winrt, ios or android. When omitted, the command prints all the targets available for a host OS. Note that winrt is only available on Windows, and ios is only available on Mac OS.

--help, -h: Display help text

--extension <Extension>

Extension of packages to list {wasm,src_doc_examples,preview,wasm_preview,x86_64,x86,armv7,arm64_v8a}

Use the --extensions flag to list all relevant options for a host/target. Incompatible with the --extensions flag, but may be combined with any other flag.

--extensions (<Qt version> | latest): Qt version in the format of “5.X.Y”, or the keyword latest. When set, this prints all valid arguments for the --extension flag for Qt 5.X.Y, or the latest version of Qt if latest is specified. Incompatible with the --extension flag.

--spec <Specification>: Print versions of Qt within a SimpleSpec that specifies a range of versions. You can specify partial versions, inequalities, etc. "*" would match all versions of Qt; ">6.0.2,<6.2.0" would match all versions of Qt between 6.0.2 and 6.2.0, etc. For example, aqt list-qt windows desktop --spec "5.12" would print all versions of Qt for Windows Desktop beginning with 5.12. May be combined with any other flag to filter the output of that flag.

--modules (<Qt version> | latest) <architecture>: This flag lists all the modules available for Qt 5.X.Y with a host/target/extension/architecture combination, or the latest version of Qt if latest is specified. You can list available architectures by using aqt list-qt with the --arch flag described below.

--arch (<Qt version> | latest): Qt version in the format of “5.X.Y”. When set, this prints all architectures available for Qt 5.X.Y with a host/target/extension, or the latest version of Qt if latest is specified.

--archives (<Qt version> | latest) architecture [modules...]

This flag requires a list of at least two arguments: ‘Qt version’ and ‘architecture’. The ‘Qt version’ argument can be in the format “5.X.Y” or the “latest” keyword. You can use the --arch flag to see a list of acceptable values for the ‘architecture’ argument. Any following arguments must be the names of modules available for the preceding version and architecture. You can use the --modules flag to see a list of acceptable values.

If you do not add a list of modules to this flag, this command will print a list of all the archives that make up the base Qt installation.

If you add a list of modules to this flag, this command will print a list of all the archives that make up the specified modules.

The purpose of this command is to show you what arguments you can pass to the archives flag when using the install-* commands. This flag allows you to avoid installing parts of Qt that you do not need.

--latest-version: Print only the newest version available May be combined with the --extension and/or --spec flags.

list-tool command

aqt list-tool [-h | --help] [-l | --long] <host> [<target>] [<tool name>]

List available tools

host: linux, windows or mac

target: desktop, winrt, ios or android. When omitted, the command prints all the targets available for a host OS. Note that winrt is only available on Windows, and ios is only available on Mac OS.

tool name

The name of a tool. Use aqt list-tool <host> <target> to see accepted values. When set, this prints all ‘tool variant names’ available.

The output of this command is meant to be used with the aqt install-tool below.

--help, -h: Display help text

--long, -l: Long display: shows extra metadata associated with each tool variant. This metadata is displayed in a table, and includes versions and release dates for each tool. If your terminal is wider than 95 characters, aqt list-tool will also display the names and descriptions for each tool. An example of this output is displayed below.

$ python -m aqt list-tool windows desktop tools_conan -l

 Tool Variant Name           Version         Release Date     Display Name              Description
============================================================================================================
qt.tools.conan         1.33-202102101246     2021-02-10     Conan 1.33          Conan command line tool 1.33
qt.tools.conan.cmake   0.16.0-202102101246   2021-02-10     Conan conan.cmake   Conan conan.cmake (0.16.0)

Install-* Commands

These commands are used to install Qt, tools, source, docs, and examples.

Common Options

Most of these commands share the same command line options, and these options are described here:

--help, -h: Display help text

--outputdir, -O <Output Directory>: Specify output directory. By default, aqt installs to the current working directory.

--base, -b <base url>: Specify mirror site base url such as -b https://mirrors.dotsrc.org/qtproject where ‘online’ folder exist.

--timeout <timeout(sec)>: The connection timeout, in seconds, for the download site. (default: 5 sec)

--external, -E <7zip command>: Specify external 7zip command path. By default, aqt uses py7zr for this task.

--internal: Use the internal extractor, py7zr

--keep, -k: Keep downloaded archive when specified, otherwise remove after install

--modules, -m (<list of modules> | all)

Specify extra modules to install as a list. Use the list-qt command to list available modules.

This option is applicable to all the install-* commands except for install-tool.

You can install multiple modules like this:

$ aqt install-* <host> <target> <Qt version> -m qtcharts qtdatavis3d qtlottie qtnetworkauth \
    qtpurchasing qtquicktimeline qtscript qtvirtualkeyboard qtwebglplugin

If you wish to install every module available, you may use the all keyword instead of a list of modules, like this:

aqt install-* <host> <target> <Qt version> <arch> -m all

--archives <list of archives>

[Advanced] Specify subset of archives to limit installed archives. This is advanced option and not recommended to use for general usage. Main purpose is speed up CI/CD process by limiting installed modules. It can cause broken installation of Qt SDK.

This option is applicable to all the install-* commands except for install-tool.

You can print a list of all acceptable values to use with this command by using aqt list-qt with the archives flag.

install-qt command

aqt install-qt
    [-h | --help]
    [-O | --outputdir <directory>]
    [-b | --base <mirror url>]
    [--timeout <timeout(sec)>]
    [-E | --external <7zip command>]
    [--internal]
    [-k | --keep]
    [-m | --modules (all | <module> [<module>...])]
    [--archives <archive> [<archive>...]]
    [--noarchives]
    <host> <target> (<Qt version> | <spec>) [<arch>]

Install Qt library, with specified version and target. There are various combinations to accept according to Qt version.

host: linux, windows or mac. The operating system on which the Qt development tools will run.

target: desktop, ios, winrt, or android. The type of device for which you are developing Qt programs.

Qt version: This is a Qt version such as 5.9.7, 5.12.1 etc. Use the list-qt command to list available versions.

spec

This is a SimpleSpec that specifies a range of versions. If you type something in the <Qt version> positional argument that cannot be interpreted as a version, it will be interpreted as a SimpleSpec, and aqt will select the highest available version within that SimpleSpec.

For example, aqt install-qt mac desktop 5.12 would install the newest version of Qt 5.12 available, and aqt install-qt mac desktop "*" would install the highest version of Qt available.

When using this option, aqt will print the version that it has installed in the logs so that you can verify it easily.

arch

The compiler architecture for which you are developing. Options:

gcc_64 for linux desktop
clang_64 for mac desktop
win64_msvc2019_64, win64_msvc2017_64, win64_msvc2015_64, win32_msvc2015, win32_mingw53 for windows desktop
android_armv7, android_arm64_v8a, android_x86, android_x86_64 for android

Use the list-qt command to list available architectures.

--noarchives: [Advanced] Specify not to install all base packages. This is advanced option and you should use it with --modules option. This allow you to add modules to existent Qt installation.

See common options.

install-src command

aqt install-src
    [-h | --help]
    [-O | --outputdir <directory>]
    [-b | --base <mirror url>]
    [--timeout <timeout(sec)>]
    [-E | --external <7zip command>]
    [--internal]
    [-k | --keep]
    [-m | --modules (all | <module> [<module>...])]
    [--archives <archive> [<archive>...]]
    [--kde]
    <host> <target> (<Qt version> | <spec>)

Install Qt source code for the specified version and target.

host: linux, windows or mac

target: desktop, ios or android

Qt version: This is a Qt version such as 5.9.7, 5.12.1 etc. Use the list-qt command to list available versions.

spec

This is a SimpleSpec that specifies a range of versions. If you type something in the <Qt version> positional argument that cannot be interpreted as a version, it will be interpreted as a SimpleSpec, and aqt will select the highest available version within that SimpleSpec.

For example, aqt install-qt mac desktop 5.12 would install the newest version of Qt 5.12 available, and aqt install-qt mac desktop "*" would install the highest version of Qt available.

--kde: by adding --kde option, KDE patch collection is applied for qtbase tree. It is only applied to Qt 5.15.2. When specified version is other than it, command will abort with error when using --kde.

See common options.

install-doc command

aqt install-doc
    [-h | --help]
    [-O | --outputdir <directory>]
    [-b | --base <mirror url>]
    [--timeout <timeout(sec)>]
    [-E | --external <7zip command>]
    [--internal]
    [-k | --keep]
    [-m | --modules (all | <module> [<module>...])]
    [--archives <archive> [<archive>...]]
    <host> <target> (<Qt version> | <spec>)

Install Qt documentation for the specified version and target.

host: linux, windows or mac

target: desktop, ios or android

Qt version: This is a Qt version such as 5.9.7, 5.12.1 etc. Use the list-qt command to list available versions.

spec

This is a SimpleSpec that specifies a range of versions. If you type something in the <Qt version> positional argument that cannot be interpreted as a version, it will be interpreted as a SimpleSpec, and aqt will select the highest available version within that SimpleSpec.

For example, aqt install-qt mac desktop 5.12 would install the newest version of Qt 5.12 available, and aqt install-qt mac desktop "*" would install the highest version of Qt available.

See common options.

install-example command

aqt install-example
    [-h | --help]
    [-O | --outputdir <directory>]
    [-b | --base <mirror url>]
    [--timeout <timeout(sec)>]
    [-E | --external <7zip command>]
    [--internal]
    [-k | --keep]
    [-m | --modules (all | <module> [<module>...])]
    [--archives <archive> [<archive>...]]
    <host> <target> (<Qt version> | <spec>)

Install Qt examples for the specified version and target.

host: linux, windows or mac

target: desktop, ios or android

Qt version: This is a Qt version such as 5.9.7, 5.12.1 etc. Use the list-qt command to list available versions.

spec

This is a SimpleSpec that specifies a range of versions. If you type something in the <Qt version> positional argument that cannot be interpreted as a version, it will be interpreted as a SimpleSpec, and aqt will select the highest available version within that SimpleSpec.

For example, aqt install-qt mac desktop 5.12 would install the newest version of Qt 5.12 available, and aqt install-qt mac desktop "*" would install the highest version of Qt available.

See common options.

install-tool command

aqt install-tool
    [-h | --help]
    [-O | --outputdir <directory>]
    [-b | --base <mirror url>]
    [--timeout <timeout(sec)>]
    [-E | --external <7zip command>]
    [--internal]
    [-k | --keep]
    <host> <target> <tool name> [<tool variant name>]

Install tools like QtIFW, mingw, Cmake, Conan, and vcredist.

host: linux, windows or mac

target: desktop, ios or android

tool name: install tools specified. tool name may be ‘tools_openssl_x64’, ‘tools_vcredist’, ‘tools_ninja’, ‘tools_ifw’, ‘tools_cmake’

tool variant name: Optional field to specify tool variant. It may be required for vcredist and mingw installation. tool variant names may be ‘qt.tools.win64_mingw810’, ‘qt.tools.vcredist_msvc2013_x64’.

You should use the list-tool command to display what tools and tool variant names are available.

See common options.

Legacy subcommands

The subcommands install, tool, src, doc, and examples have been deprecated in favor of the newer install-* commands, but they remain in aqt in case you still need to use them. Documentation for these older commands is still available at https://aqtinstall.readthedocs.io/en/v1.2.4/

Command examples

Example: Installing Qt SDK 5.12.0 for Linux with QtCharts and QtNetworkAuth:

pip install aqtinstall
sudo aqt install-qt --outputdir /opt linux desktop 5.12.0 -m qtcharts qtnetworkauth

Example: Installing the newest LTS version of Qt 5.12:

pip install aqtinstall
sudo aqt install-qt linux desktop 5.12 win64_mingw73

Example: Installing Android (armv7) Qt 5.10.2:

aqt install-qt linux android 5.10.2 android_armv7

Example: Install examples, doc and source:

aqt install-example windows desktop 5.15.2 -m qtcharts qtnetworkauth
aqt install-doc windows desktop 5.15.2 -m qtcharts qtnetworkauth
aqt install-src windows desktop 5.15.2 --archives qtbase --kde

Example: Install Web Assembly

aqt install-qt linux desktop 5.15.0 wasm_32

Example: List available versions of Qt on Linux

aqt list-qt linux desktop

Example: List available versions of Qt6 on macOS

aqt list-qt mac desktop --spec "6"

Example: List available modules for latest version of Qt on macOS

aqt list-qt mac desktop --modules latest clang_64   # prints 'qtquick3d qtshadertools', etc

Example: List available architectures for Qt 6.1.2 on windows

aqt list-qt windows desktop --arch 6.1.2    # prints 'win64_mingw81 win64_msvc2019_64', etc

Example: List available tools on windows

aqt list-tool windows desktop    # prints 'tools_ifw tools_qtcreator', etc

Example: List the variants of IFW available:

aqt list-tool linux desktop tools_ifw       # prints 'qt.tools.ifw.41'
# Alternate: `tools_` prefix is optional
aqt list-tool linux desktop ifw             # prints 'qt.tools.ifw.41'

Example: List the variants of IFW, including version, release date, description, etc.:

aqt list-tool linux desktop tools_ifw -l    # prints a table of metadata

Example: Install an Install FrameWork (IFW):

aqt install-tool linux desktop tools_ifw

Example: Install vcredist on Windows:

aqt install-tool windows tools_vcredist
.\Qt\Tools\vcredist\vcredist_msvc2019_x64.exe /norestart /q

Example: Install MinGW on Windows

aqt install-tool -O c:\Qt windows tools_mingw qt.tools.win64_mingw810
set PATH=C:\Qt\Tools\mingw810_64\bin

Example: Show help message

aqt help