Unity Hub

https://docs.unity.com/en-us/hub
Admin
Unity Hub is a standalone application used to manage, download, and install Unity Editor versions...
Tokens:10,701
Snippets:197
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### GET https://link.unity.com/hub/package-manager/install/{package-and-version}

Source: https://docs.unity.com/en-us/hub/deeplinking-support

Opens the Package Manager window in a selected project to install a specific package version.

```APIDOC
## GET https://link.unity.com/hub/package-manager/install/{package-and-version}

### Description
Opens the Package Manager window within a project to select and install a specific package and version.

### Method
GET

### Endpoint
https://link.unity.com/hub/package-manager/install/{package-and-version}

### Parameters
#### Path Parameters
- **package-and-version** (string) - Required - The identifier and version of the package to install.
```

--------------------------------

### GET https://link.unity.com/hub/project/{cloud-project-id}/package-manager/install/{package-and-version}

Source: https://docs.unity.com/en-us/hub/deeplinking-support

Opens a specific cloud-connected project and triggers the Package Manager installation flow.

```APIDOC
## GET https://link.unity.com/hub/project/{cloud-project-id}/package-manager/install/{package-and-version}

### Description
Directly opens a specific cloud-connected local project and triggers the Package Manager window for the specified package.

### Method
GET

### Endpoint
https://link.unity.com/hub/project/{cloud-project-id}/package-manager/install/{package-and-version}

### Parameters
#### Path Parameters
- **cloud-project-id** (string) - Required - The project ID found in the Unity Dashboard Settings.
- **package-and-version** (string) - Required - The identifier and version of the package to install.
```

--------------------------------

### Install Unity Hub Beta

Source: https://docs.unity.com/en-us/hub/install-hub-linux

Updates the local package cache and installs a specific version of the Unity Hub.

```shell
sudo apt update
sudo apt install unityhub=<version>
```

--------------------------------

### Set or get the Editor install path

Source: https://docs.unity.com/en-us/hub/use-hub-cli

Use the install-path command to configure or retrieve the directory where Unity Editors are installed.

```shell
/Applications/Unity\ Hub.app/Contents/MacOS/Unity\ Hub -- --headless install-path -s /Applications/Unity/Hub/Editor/
```

```shell
C:\Program Files\Unity Hub>"Unity Hub.exe" -- --headless install-path -s "C:\Program Files\Unity\Hub\Editor\"
```

```shell
~/Applications/Unity\ Hub.AppImage --headless install-path -s /Applications/Unity/Hub/Editor/
```

--------------------------------

### Install an Editor with modules

Source: https://docs.unity.com/en-us/hub/use-hub-cli

Installs a new Unity Editor version along with specified modules in a single command.

```shell
/Applications/Unity\ Hub.app/Contents/MacOS/Unity\ Hub -- --headless install --version 6000.3.7f1 --module android android-sdk-ndk-tools android-open-jdk
```

```shell
"C:\Program Files\Unity Hub\Unity Hub.exe" -- --headless install --version 6000.3.7f1 --module android android-sdk-ndk-tools android-open-jdk
```

```shell
~/Applications/Unity\ Hub.AppImage --headless install --version 6000.3.7f1 --module android android-sdk-ndk-tools android-open-jdk
```

--------------------------------

### Install a Unity Editor

Source: https://docs.unity.com/en-us/hub/use-hub-cli

Use the install command to download a specific Editor version. Include the --changeset flag if the version is not in the standard release list.

```shell
/Applications/Unity\ Hub.app/Contents/MacOS/Unity\ Hub -- --headless install --version 6000.3.7f1 --changeset 9b001d489a54
```

```shell
C:\Program Files\Unity Hub>"Unity Hub.exe" -- --headless install --version 6000.3.7f1 --changeset 9b001d489a54
```

```shell
~/Applications/Unity\ Hub.AppImage --headless install --version 6000.3.7f1 --changeset 9b001d489a54
```

--------------------------------

### Create project and install package via URL

Source: https://docs.unity.com/en-us/hub/deeplinking-support

Use this URL format to initiate a new project creation and open the Package Manager automatically.

```html
https://link.unity.com/hub/project/new/package-manager/install/{package-and-version}
```

--------------------------------

### Install stable Unity Hub on Debian

Source: https://docs.unity.com/en-us/hub/install-hub-linux

Commands to disable the beta repository and install the stable version of Unity Hub.

```shell
sudo mv /etc/apt/sources.list.d/unityhub-beta.list /etc/apt/sources.list.d/unityhub-beta.list.bak
sudo apt update
sudo apt install unityhub
```

```shell
sudo apt install unityhub=3.x.x
```

--------------------------------

### install

Source: https://docs.unity.com/en-us/hub/hub-cli-reference

Installs a specific version of the Unity Editor, with optional support for modules and architecture selection.

```APIDOC
## install (alias: i)

### Description
Installs a new Editor from the releases list or archive.

### Options
- **--version** (alias: -v) - Required - Editor version to install (e.g., -v 2022.1.1f1).
- **--changeset** (alias: -c) - Optional - Editor changeset. Required if the version is not in the release list.
- **--module** (alias: -m) - Optional - Module ID to install. Multiple IDs can be passed.
- **--childModules** (alias: --cm) - Optional - Downloads child modules for the specified modules.
- **--architecture** (alias: -a) - Optional - macOS only: Select the Apple Silicon (arm64) or Intel (x86_64) Editor build. Default is Intel.
```

--------------------------------

### Install stable Unity Hub on RHEL/CentOS/Fedora

Source: https://docs.unity.com/en-us/hub/install-hub-linux

Commands to disable the beta repository and install the stable version of Unity Hub on RHEL-based systems.

```shell
sudo mv /etc/yum.repos.d/unityhub_beta.repo /etc/yum.repos.d/unityhub_beta.repo.bak
sudo dnf check-update
sudo dnf install unityhub
```

```shell
sudo dnf list unityhub
sudo dnf install unityhub-<version info>
```

--------------------------------

### install-modules

Source: https://docs.unity.com/en-us/hub/hub-cli-reference

Downloads and installs a module for an installed Editor. Requires the Editor version and the module ID.

```APIDOC
## CLI Command: install-modules

### Description
Downloads and installs a module for an installed Editor. Note that this only applies to Editors installed through the Unity Hub.

### Usage
`unity-hub install-modules --version <version> --module <module-id> [--childModules]`

### Parameters
- **--version** (string) - Required - The installed Editor version to add the module to (e.g., 6000.3.7f1).
- **--module** (string) - Required - The Module ID to install. Multiple module IDs can be passed.
- **--childModules** (boolean) - Optional - Downloads child modules for the specified module.
```

--------------------------------

### List available and installed Editors

Source: https://docs.unity.com/en-us/hub/use-hub-cli

Use the editors command to list releases or installed versions. Specify -r for releases, -i for installed, or -a for both.

```shell
/Applications/Unity\ Hub.app/Contents/MacOS/Unity\ Hub -- --headless editors -r
```

```shell
C:\Program Files\Unity Hub> "Unity Hub.exe" -- --headless editors -r
```

```shell
~/Applications/Unity\ Hub.AppImage --headless editors -r
```

--------------------------------

### Install Unity Hub Package

Source: https://docs.unity.com/en-us/hub/install-hub-linux

Updates the package cache and installs the Unity Hub using the dnf package manager.

```shell
sudo dnf check-update
sudo dnf install unityhub
```

--------------------------------

### Install curl on Ubuntu

Source: https://docs.unity.com/en-us/hub/install-hub-linux

Ensure curl is installed on your system before running the installation scripts.

```shell
sudo apt install curl
```

--------------------------------

### Update and install Unity Hub

Source: https://docs.unity.com/en-us/hub/install-hub-linux

Refreshes the package cache and installs the Unity Hub package.

```shell
sudo apt update
sudo apt install unityhub
```

--------------------------------

### GET https://link.unity.com/hub/project/new

Source: https://docs.unity.com/en-us/hub/deeplinking-support

Activates the Unity Hub and navigates to the Create New Project page.

```APIDOC
## GET https://link.unity.com/hub/project/new

### Description
Activates the Unity Hub and opens the Create New Project page.

### Method
GET

### Endpoint
https://link.unity.com/hub/project/new
```

--------------------------------

### Install a package to a local project via URL

Source: https://docs.unity.com/en-us/hub/deeplinking-support

Deeplinks to open the Package Manager window for a specific package. Requires the user to select a project unless a cloud project ID is provided.

```html
https://link.unity.com/hub/package-manager/install/{package-and-version}
```

```html
https://link.unity.com/hub/project/{cloud-project-id}/package-manager/install/{package-and-version}
```

--------------------------------

### install-path

Source: https://docs.unity.com/en-us/hub/hub-cli-reference

Sets or retrieves the directory path where Unity Editors are installed on the local machine.

```APIDOC
## install-path (alias: ip)

### Description
Sets or gets the path where you install Unity Editors on your machine. If no option is provided, the command defaults to --get.

### Options
- **--set <path>** (alias: -s) - Sets the Editor install path to the given path.
- **--get** (alias: -g) - Shows the current Editor install path.
```

--------------------------------

### Install modules on an existing Editor

Source: https://docs.unity.com/en-us/hub/use-hub-cli

Adds specified modules to an Editor previously installed via the Hub. Requires the exact version string and module IDs.

```shell
/Applications/Unity\ Hub.app/Contents/MacOS/Unity\ Hub -- --headless install-modules --version 6000.3.7f1 -m ios android
```

```shell
C:\Program Files\Unity Hub>"Unity Hub.exe" -- --headless install-modules --version 6000.3.7f1 -m ios android
```

```shell
~/Applications/Unity\ Hub.AppImage --headless install-modules --version 6000.3.7f1 -m ios android
```

--------------------------------

### GET https://link.unity.com/hub/package-manager/download/{asset-store-id}

Source: https://docs.unity.com/en-us/hub/deeplinking-support

Opens the Package Manager window to download a specific asset from the Asset Store.

```APIDOC
## GET https://link.unity.com/hub/package-manager/download/{asset-store-id}

### Description
Opens the Package Manager window with the specified Asset Store asset selected for download.

### Method
GET

### Endpoint
https://link.unity.com/hub/package-manager/download/{asset-store-id}

### Parameters
#### Path Parameters
- **asset-store-id** (string) - Required - The unique identifier for the asset in the Asset Store.
```

--------------------------------

### editors

Source: https://docs.unity.com/en-us/hub/hub-cli-reference

Lists available releases and installed Editors on the machine.

```APIDOC
## editors (alias: e)

### Description
Lists available releases and installed Editors on your machine.

### Options
- **--all** (alias: -a) - Lists available releases and installed Editors.
- **--releases** (alias: -r) - Lists available releases.
- **--installed** (alias: -i) - Lists installed Editors.
```

--------------------------------

### GET https://link.unity.com/hub/project/{cloud-project-id}/package-manager/download/{asset-store-id}

Source: https://docs.unity.com/en-us/hub/deeplinking-support

Opens a specific cloud-connected project and triggers the Package Manager download flow for an asset.

```APIDOC
## GET https://link.unity.com/hub/project/{cloud-project-id}/package-manager/download/{asset-store-id}

### Description
Directly opens a specific cloud-connected local project and triggers the Package Manager window for the specified Asset Store asset.

### Method
GET

### Endpoint
https://link.unity.com/hub/project/{cloud-project-id}/package-manager/download/{asset-store-id}

### Parameters
#### Path Parameters
- **cloud-project-id** (string) - Required - The project ID found in the Unity Dashboard Settings.
- **asset-store-id** (string) - Required - The unique identifier for the asset in the Asset Store.
```

--------------------------------

### Activate Unity Hub via command line

Source: https://docs.unity.com/en-us/hub/deeplinking-support

Commands to open the Create New Project interface from different operating systems.

```shell
open unityhub://editor/project/new
```

```shell
start "" unityhub://editor/project/new
```

```shell
xdg-open unityhub://editor/project/new
```

--------------------------------

### Add Unity Hub Beta Repository

Source: https://docs.unity.com/en-us/hub/install-hub-linux

Creates a repository configuration file for the unstable beta channel in the apt sources directory.

```shell
echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/unityhub.gpg] https://hub.unity3d.com/linux/repos/deb unstable main" | sudo tee /etc/apt/sources.list.d/unityhub-beta.list
```

--------------------------------

### Create missing sources directory

Source: https://docs.unity.com/en-us/hub/install-hub-linux

Manually create the apt sources directory and the unityhub list file if they are missing.

```shell
 sudo mkdir /etc/apt/sources.list.d
 sudo touch /etc/apt/sources.list.d/unityhub.list
```

--------------------------------

### Create a new local project via URL

Source: https://docs.unity.com/en-us/hub/deeplinking-support

Use this URL to open the Unity Hub directly to the Create New Project page.

```html
https://link.unity.com/hub/project/new
```

--------------------------------

### help

Source: https://docs.unity.com/en-us/hub/hub-cli-reference

Displays available CLI commands, flags, and argument types.

```APIDOC
## help (alias: h)

### Description
Lists available CLI commands and their flags and argument types.

### Usage
`-- --headless help` or `-- --headless h`
```

--------------------------------

### Display Hub CLI help

Source: https://docs.unity.com/en-us/hub/use-hub-cli

Lists available commands and flags for the Hub CLI across different operating systems.

```shell
/Applications/Unity\ Hub.app/Contents/MacOS/Unity\ Hub -- --headless help
```

```shell
C:\Program Files\Unity Hub> "Unity Hub.exe" -- --headless help
```

```shell
~/Applications/Unity\ Hub.AppImage --headless help
```

--------------------------------

### Add Unity Hub repository

Source: https://docs.unity.com/en-us/hub/install-hub-linux

Adds the Unity Hub repository to the apt sources list for x86_64/amd64 architectures.

```shell
echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/unityhub.gpg] https://hub.unity3d.com/linux/repos/deb stable main" | sudo tee /etc/apt/sources.list.d/unityhub.list
```

--------------------------------

### Add Unity Hub public signing key

Source: https://docs.unity.com/en-us/hub/install-hub-linux

Creates the keyring directory and adds the public GPG key to verify package integrity.

```shell
sudo install -d /etc/apt/keyrings
curl -fsSL https://hub.unity3d.com/linux/keys/public | sudo gpg --dearmor -o /etc/apt/keyrings/unityhub.gpg
```

--------------------------------

### Download an asset from the Asset Store via URL

Source: https://docs.unity.com/en-us/hub/deeplinking-support

Deeplinks to open the Package Manager window with a specific Asset Store item selected. Requires the user to select a project unless a cloud project ID is provided.

```html
https://link.unity.com/hub/package-manager/download/{asset-store-id}
```

```html
https://link.unity.com/hub/project/{cloud-project-id}/package-manager/download/{asset-store-id}
```

--------------------------------

### Configure Unity Hub Repository

Source: https://docs.unity.com/en-us/hub/install-hub-linux

Adds the Unity Hub repository configuration to the system's yum repository directory.

```shell
sudo sh -c 'echo -e "[unityhub]\nname=Unity Hub\nbaseurl=https://hub.unity3d.com/linux/repos/rpm/stable\nenabled=1\ngpgcheck=1\ngpgkey=https://hub.unity3d.com/linux/repos/rpm/stable/repodata/repomd.xml.key\nrepo_gpgcheck=1" > /etc/yum.repos.d/unityhub.repo'
```

```shell
sudo sh -c 'echo -e "[unityhub-beta]\nname=Unity Hub Beta\nbaseurl=https://hub.unity3d.com/linux/repos/rpm/unstable\nenabled=1\ngpgcheck=1\ngpgkey=https://hub.unity3d.com/linux/repos/rpm/unstable/repodata/repomd.xml.key\nrepo_gpgcheck=1" > /etc/yum.repos.d/unityhub_beta.repo'
```

--------------------------------

### Check and Update Unity Hub on RHEL/CentOS/Fedora

Source: https://docs.unity.com/en-us/hub/install-hub-linux

Checks for available package updates and applies them for the Unity Hub package.

```shell
sudo dnf check-update
sudo dnf update unityhub
```

--------------------------------

### Remove Unity Hub

Source: https://docs.unity.com/en-us/hub/install-hub-linux

Uninstalls the Unity Hub package from the system.

```shell
sudo apt remove unityhub
```

--------------------------------

### Check for Updates on Debian/Ubuntu

Source: https://docs.unity.com/en-us/hub/install-hub-linux

Refreshes the local package list to check for available updates.

```shell
sudo apt update
```

--------------------------------

### Fix interrupted package configuration

Source: https://docs.unity.com/en-us/hub/install-hub-linux

Commands to resolve dpkg interruption errors during package removal.

```shell
sudo apt remove unityhub
E: dpkg was interrupted, you must manually run 'sudo dpkg --configure -a' to correct the problem. 
ubuntity@ubuntu:~$ sudo dpkg --configure -a
```

--------------------------------

### Resolve lockfile errors

Source: https://docs.unity.com/en-us/hub/install-hub-linux

Commands to identify and terminate processes holding the dpkg lockfile.

```shell
E: Could not get lock /var/lib/dpkg/lock-frontend. It is held by process 4076
```

```shell
sudo kill -9 4076
```

--------------------------------

### Forward custom deeplink to handler

Source: https://docs.unity.com/en-us/hub/deeplinking-support

URL formats for forwarding deeplinks to a specific handler namespace, with an optional cloud project ID.

```html
https://link.unity.com/hub/editor/{handler-namespace}/*
```

```html
https://link.unity.com/hub/project/{cloud-project-id}/{handler-namespace}/*
```

--------------------------------

### Invoke deeplink from C# script

Source: https://docs.unity.com/en-us/hub/deeplinking-support

Use Application.OpenURL to trigger Unity Hub deeplinks from within the Unity Editor.

```csharp
Application.OpenURL("unityhub://editor/project/new");
```
Tokens:
Raw