Hub, agent and remote take the same command-line options. hub --help prints
them, and hub --help-all adds Qt's own. This page groups them by what you
use them for.
Start and identity
| Option |
Meaning |
-d, --base-dir <path> |
Use this data folder in place of the default one. Keep the path short: a local socket path is limited to 108 bytes |
--node-id <id> |
Activate this node identity at startup. Without it, the last active identity is used |
-e, --head-less |
Run with no window |
--fullscreen |
Show the main window fullscreen, for a kiosk or a display with no window manager |
--hive <hive-id> |
Mount this hive at startup |
--hive-passphrase-file <path> |
Read the hive passphrase from the first line of this file |
--hive-passphrase-stdin |
Read the hive passphrase from the first line of standard input |
--hive-passphrase <passphrase> |
The hive passphrase itself. Other users can see it in the process list, so prefer one of the two options above |
--join-file <path> |
Join the fleet that this bootstrap file names. The file is deleted once the join succeeds |
--debug-control <on|off> |
Debug builds only. on lets an agent act as the device owner on this node. Saved with the node |
Pages and OPAL
| Option |
Meaning |
-a, --activity <name> |
Start on the named page. A short name works when it is unique, for example MonitorActivity |
-f, --open <file> |
Open a file in the page of --activity |
-j, --project <name> |
A test project name, for the page of --activity |
-x, --opal <plan> |
Run an OPAL plan at startup: a task with key=value arguments, inline JSON, or @file. Give it more than once to run several plans, one after the other. See OPAL system tasks |
-c, --close-on-completion |
Quit when the work is done: after the last --opal plan, with exit code 0 when every plan succeeded and 1 otherwise |
Network
| Option |
Meaning |
-l, --local-host <host> |
The address to listen on |
-p, --local-port <port> |
The port to listen on |
-r, --remote-host <host> |
The remote host to target |
-o, --remote-port <port> |
The remote port to target |
--zoo-url <url> |
The Zoo server's API address, for this run. It overrides the zoo/url setting |
Rendering
| Option |
Meaning |
--rhi-backend <name> |
Force a render backend: vulkan, d3d12, opengl, metal or null. There is no fallback: if that backend cannot start, the app does not start |
--rhi-software |
Ask the driver for a software rasterizer |
--rhi-debug |
Turn on the graphics API's debug layer and Qt's render debug output |
--rhi-validate, --no-rhi-validate |
Turn the Vulkan validation layer on or off. Debug builds have it on, release builds off |
--opengl <mode> |
The OpenGL implementation to ask Qt for: software, desktop or auto |
--user-data |
Use this user's own settings and data, as a release build does. A debug build without it keeps its data in data/<app> beside its program. --base-dir wins over it |
--audio-backend <name> |
Qt's audio backend on Linux: pulseaudio (the default) or pipewire. A PipeWire host serves PulseAudio too; Qt 6.10's PipeWire device monitor can crash an app at start |
--d3d-max-frame-latency <n> |
Frames a Direct3D swap chain may queue before it waits, 0 to 16. Default 1 |
--gpu-markers |
Name each GPU pass for PIX, Radeon GPU Profiler and RenderDoc |
--dump-frames <dir> |
Save every worker viewport frame as a PNG in this folder |
Diagnosis
| Option |
Meaning |
--log <categories> |
Log detail per category, for example session:full,scheduling:summary |
--log-detail <level> |
normal or verbose for this run. The setting Log detail chooses it for every run |
--gui-heartbeat |
Log every stall of the GUI thread over 250 ms, with its phase |
--tick-trace |
Log the latency and depth of each worker queue item and render tick |
--no-codec-probe |
Skip the video codec probe at startup |
--no-peer-demote |
Do not lower the priority of build programs when this app cannot raise its own |
--pantry-layers <layers> |
The asset layers to use, comma separated: live, cache, resource. Default: all three |
--pantry-source <path> |
Read bundled assets from this source checkout, for one run |
| Option |
Meaning |
-h, --help |
Print the options |
--help-all |
Print the options, Qt's own included |
-v, --version |
Print the version |