Documentation

​
​

Development

User Acquisition

Monetization

Industry

Unity Gaming Services CLI

v1.4

Legacy
​
GitHub Repository

Unity Gaming Services CLI

v1.4

Legacy
​
​
​
Unity Gaming Services CLI
  • Overview
Get started
  • Install the CLI
  • Set up a Common Configuration
  • Get Authenticated
  • Use Your First Command
Base commands
  • Configuration
  • Deploy
  • Environment
  • Fetch
  • Login
  • Logout
  • Status
Deployment definition
  • What is a Deployment Definition
  • Commands for Deployment Definition
  • Excludes
  • Troubleshooting Deployment Definition
Samples
  • CI/CD Pipeline Usage
  • Deploy Samples
  • File Type Associations
  • Redirecting Command Result to File
Troubleshooting
  • Project Roles
  • Unauthorized (Error 403)
CLI Services Documentation
  • Access
  • Cloud Code
  • Cloud Content Delivery
  • Cloud Save
  • Economy
  • Game Server Hosting
  • Leaderboards
  • Lobby
  • Player
  • Remote Config
  • Scheduler
  • Triggers
  1. Overview

Install the CLI

Install the CLI using the bash installer, npm, or from the GitHub repository.
Read time 2 minutes
Last updated 3 months 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:
curl -sLo ugs_installer ugscli.unity.com/v1 && shasum -c <<<"3bbc507d4776a20d5feb4958be2ab7d4edcea8eb  ugs_installer" && bash ugs_installer
This installs the latest version of the UGS CLI. After installation, get help on how to use the CLI by typing 
ugs -h
and pressing enter.

Installer Options

Option

Description

Default Value

versionWhen added, it allows you to specify the version of the UGS CLI to installlatest
uninstallWhen set to true, it allows you to uninstall the UGS CLIfalse
diagnosticsWhen set to false, installation diagnostics will not be senttrue

Usage Examples

Installing a specific version of the CLI (1.0.0 for example):
curl -sLo ugs_installer ugscli.unity.com/v1 && shasum -c <<<"3bbc507d4776a20d5feb4958be2ab7d4edcea8eb  ugs_installer" && version=1.0.0 bash ugs_installer
Uninstalling the CLI:
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 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 file for your operating system.
  4. Rename the file to ugs.
  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 System

Required Version

Windows10 or later
LinuxUbuntu, Alpine or other major distros
MacOS10.15 or later
Copyright © 2026 Unity Technologies
LegalPrivacy PolicyCookiesDocumentation Terms of UseDo Not Sell or Share My Personal InformationYour Privacy Choices (Cookie Settings)

"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S and elsewhere (more info here). Other names or brands are trademarks of their respective owners.

Some pages are machine-translated for convenience, and may contain inaccuracies. In the event of conflicting information, the English version is authoritative.

  • On this page

    • With the Bash Installer (MacOS, Linux)

      • Installer Options

      • Usage Examples

    • With npm

    • From GitHub

    • Operating System Compatibility