Install the CLI
Install the CLI using the bash installer, npm, or from the GitHub repository.
Read time 1 minuteLast updated 21 hours ago
With the Bash Installer (MacOS, Linux)
To install the CLI with the bash installer, type and run the following command in your command line:This installs the latest version of the UGS CLI. After installation, get help on how to use the CLI by typingcurl -sLo ugs_installer ugscli.unity.com/v1 && shasum -c <<<"3bbc507d4776a20d5feb4958be2ab7d4edcea8eb ugs_installer" && bash ugs_installer
ugs -hInstaller Options
Option | Description | Default Value |
|---|---|---|
| version | When added, it allows you to specify the version of the UGS CLI to install | latest |
| uninstall | When set to true, it allows you to uninstall the UGS CLI | false |
| diagnostics | When set to false, installation diagnostics will not be sent | true |
Usage Examples
Installing a specific version of the CLI (1.0.0 for example):Uninstalling the CLI:curl -sLo ugs_installer ugscli.unity.com/v1 && shasum -c <<<"3bbc507d4776a20d5feb4958be2ab7d4edcea8eb ugs_installer" && version=1.0.0 bash ugs_installer
curl -sLo ugs_installer ugscli.unity.com/v1 && shasum -c <<<"3bbc507d4776a20d5feb4958be2ab7d4edcea8eb ugs_installer" && uninstall=true bash ugs_installer
With npm
To install the CLI with npm, make sure you have node and npm installed, then run:npm install -g ugsugsugs --versionFrom GitHub
To install official releases of the Unity Gaming Services CLI, follow these steps.- Go to the GitHub Releases page.
- Find the latest version.
- Under "Assets", click and download the file for your operating system.
- Rename the file to ugs.
- On macos and linux, use to mark the file as executable.
chmod +x <path_to_executable>