Skip to main content

Install the CLI

With npm

To install the CLI with npm, make sure you have node and npm installed, then run:

npm install -g ugs

This installs the CLI as an npm package and adds ugs to your PATH.

After installation, you should be able to call ugs --version and other commands directly from your command line.

From GitHub

To install official releases of the Unity Gaming Services CLI, follow these steps.

  1. Go to the GitHub Releases page.
  2. Find the latest version.
  3. Under "Assets", click and download the zip for your operating system.
  4. Unzip the file.
  5. On macos and linux, use chmod +x <path_to_executable> to mark the file as executable.

At this point, the CLI will be usable if called by the terminal in the same directory, or by specifying the application's path.

For convenience, you can add the executable to PATH.

Operating System Compatibility

Operating SystemRequired Version
Windows10 or later
LinuxUbuntu, Alpine or other major distros
MacOS10.15 or later