Hub CLI reference
Look up Hub command line interface (CLI) commands, flags, options, and module IDs for headless mode.
読み終わるまでの所要時間 3 分最終更新 1ヶ月前
注
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:
--errorsAs of Hub 3.7.0-beta.1:
- By default, the console output omits some errors.
- Add the flag to the command to include those errors in the output.
--errors
Display help
Command: (alias: )
helphOpen a terminal, go to the Hub app executable, and run or . On Linux, use one before . On Windows and macOS, use .
-- --headless help-- --headless h--headless-- --headlessThe help command lists available CLI commands and their flags and argument types. For examples, refer to Use the Hub CLI.
Manage Editors
Command: (alias: )
editorseLists available releases and installed Editors on your machine.
Option | Alias | Description |
|---|---|---|
| | Lists available releases and installed Editors on your machine. |
| | Lists available releases. |
| | Lists installed Editors on your machine. |
Set/Get install path
Command: (alias: )
install-pathipSets or gets the path where you install Unity Editors on your machine.
Option | Alias | Description |
|---|---|---|
| | Sets the Editor install path to the given path. |
| | Shows the current Editor install path. |
注
If you do not select an option, the command uses .
getInstall Unity Editors
Command: (alias: )
installiInstalls a new Editor from the releases list or archive.
Option | Alias | Required? | Usage | Description |
|---|---|---|---|---|
| | Yes | | Editor version to install. |
| | No | | Editor changeset. Required if the version is not in the release list. Run |
| | No | | Module ID. You can pass multiple module IDs. Refer to Install modules. |
| | No | | Also downloads child modules for the specified |
| | No | | macOS only: Select the Apple Silicon or Intel Editor build. Default: Intel ( |
Install modules
Command: (alias: )
install-modulesimDownloads and installs a module for an installed Editor.
重要
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 command with the option. For more information, refer to Install Editor with modules.
install--moduleOption | Alias | Required? | Usage | Description |
|---|---|---|---|---|
| | Yes | | Installed Editor version to add the module to. |
| | Yes | | Module ID. You can pass multiple module IDs. |
| | No | | Also downloads child modules for the specified |
Available modules
The following table lists modules you can install. You can also list modules with display help.
重要
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 | |
| Android Build Support | |
| Android SDK & NDK Tools | |
| OpenJDK | |
| iOS Build Support | |
| tvOS Build Support | |
| Language packs | |
| Linux Build Support (Mono) | |
| Linux Build Support (IL2CPP) | |
| Lumin OS (Magic Leap) Build Support | |
| Microsoft Visual Studio | |
| Mac Build Support (Mono) | |
| Mac Build Support (IL2CPP) | |
| Mac Dedicated Server Build Support | |
| Universal Windows Platform Build Support | |
| UWP Build Support (IL2CPP) | |
| UWP Build Support (.NET) | |
| Web Build Support | |
| Windows Build Support (Mono) | |
| Windows Build Support (IL2CPP) | |
| Windows Dedicated Server Build Support | |
注
When you install Android modules, always include .
--versionLog 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
- Windows: