Documentation

Unity Hub

Download Unity Hub

Unity Hub

Hub CLI reference

Look up Hub command line interface (CLI) commands, flags, options, and module IDs for headless mode.
Read time 3 minutesLast updated a day ago
Note
The Hub CLI is deprecated from version 3.18.0 of the Unity Hub. For new scripts and automation, use the Unity CLI.
This page lists Hub CLI commands, flags, and module IDs. The Hub CLI is part of the Unity Hub desktop application and runs in headless mode. For examples on each platform, refer to Use the Hub CLI.

Global flags

Flag: 
--errors
 As of Hub 3.7.0-beta.1:
  • By default, the console output omits some errors.
  • Add the 
    --errors
    flag to the command to include those errors in the output.

Display help

Command: 
help
(alias: 
h
) Open a terminal, go to the Hub app executable, and run 
-- --headless help
or 
-- --headless h
. On Linux, use one 
--
before 
headless
. On Windows and macOS, use 
-- --headless
. The help command lists available CLI commands and their flags and argument types. For examples, refer to Use the Hub CLI.

Manage Editors

Command: 
editors
(alias: 
e
) Lists available releases and installed Editors on your machine.

Option

Alias

Description

--all
-a
Lists available releases and installed Editors on your machine.
--releases
-r
Lists available releases.
--installed
-i
Lists installed Editors on your machine.

Set/Get install path

Command: 
install-path
(alias: 
ip
) Sets or gets the path where you install Unity Editors on your machine.

Option

Alias

Description

--set <path>
-s
Sets the Editor install path to the given path.
--get
-g
Shows the current Editor install path.
Note
If you do not select an option, the command uses 
get
.

Install Unity Editors

Command: 
install
(alias: 
i
) Installs a new Editor from the releases list or archive.

Option

Alias

Required?

Usage

Description

--version
-v
Yes
-v 2022.1.1f1
Editor version to install.
--changeset
-c
No
-c 9b001d489a54
Editor changeset. Required if the version is not in the release list. Run 
editors -r
to check.
--module
-m
No
-m android
or 
-m appletv webgl
Module ID. You can pass multiple module IDs. Refer to Install modules.
--childModules
--cm
No
--cm
Also downloads child modules for the specified 
--module
. For example, 
-m android -cm
downloads all Android submodules.
--architecture
-a
No
-a arm64
for Apple Silicon or 
-a x86_64
for Intel		macOS only: Select the Apple Silicon or Intel Editor build. Default: Intel (
x86_64
).

Install modules

Command: 
install-modules
(alias: 
im
) Downloads and installs a module for an installed Editor.
Important
You can only add modules to Editors you installed through the Hub. If you installed an Editor manually, reinstall it through the Hub before you add modules. To reinstall from the command line, use the 
install
command with the 
--module
option. For more information, refer to Install Editor with modules.

Option

Alias

Required?

Usage

Description

--version
-v
Yes
-v 6000.3.7f1
Installed Editor version to add the module to.
--module
-m
Yes
-m android
or 
-m appletv webgl
Module ID. You can pass multiple module IDs.
--childModules
--cm
No
--cm
Also downloads child modules for the specified 
--module
. For example, 
-m android -cm
downloads all Android submodules.

Available modules

The following table lists modules you can install. You can also list modules with display help.
Important
Module availability depends on the Editor version and platform. To see the list for your setup, open the Hub UI, select Installs, choose Manage > Add Modules for the Editor. For more information, refer to Add modules to a Unity Editor installation.

Module

Module ID

Documentation
documentation
Android Build Support
android
Android SDK & NDK Tools
android-sdk-ndk-tools
OpenJDK
android-open-jdk
iOS Build Support
ios
tvOS Build Support
appletv
Language packs
language-ja, language-ko, language-zh-cn, language-zh-hant, language-zh-hans
Linux Build Support (Mono)
linux-mono
Linux Build Support (IL2CPP)
linux-il2cpp
Lumin OS (Magic Leap) Build Support
lumin
Microsoft Visual Studio
visualstudio
Mac Build Support (Mono)
mac-mono
Mac Build Support (IL2CPP)
mac-il2cpp
Mac Dedicated Server Build Support
mac-server
Universal Windows Platform Build Support
universal-windows-platform
UWP Build Support (IL2CPP)
uwp-il2cpp
UWP Build Support (.NET)
uwp-.net
Web Build Support
webgl
Windows Build Support (Mono)
windows-mono
Windows Build Support (IL2CPP)
windows-il2cpp
Windows Dedicated Server Build Support
windows-server
Note
When you install Android modules, always include 
--version
.

Log locations

To view Hub logs, use either of these options:
  • In the Hub, go to Account > Help and Support > Logs.
  • Open the log folder on your system:
    • Windows: 
      %UserProfile%\AppData\Roaming\UnityHub\logs
    • Mac: 
      ~/Library/Application Support/UnityHub/logs
    • Linux: 
      ~/.config/UnityHub/logs