Unity Gaming Services CLI
Learn how to manage Unity Gaming Services (UGS) configuration from the command line.
Read time 2 minutesLast updated 6 days ago
The Unity Gaming Services (UGS) CLI is a command-line interface with a variety of tools to manage, test, and deploy Unity Gaming Services configuration. The UGS CLI provides a scalable and automatable alternative to the Unity Dashboard, and can improve your team workflows and productivity.
Get started
To get started with the UGS CLI, refer to the following documentation:
- To install and use the UGS CLI, follow the getting started documentation.
- Browse deployment samples for how to use Deployments.
- Examples on how to integrate UGS CLI as part of CI/CD tools:
For more commands, options, and guides, refer to the UGS CLI documentation.
Explore supported services and use cases
Use Deployments
The Deployments feature supports configuration-as-code workflows for UGS. You can use the UGS CLI to deploy file configurations using the deploy command, enabling integration into automated build pipelines (CI/CD).
The Deployments feature is also supported in the Unity Editor through packages, including Remote Config and Cloud Code. The UGS CLI enables the Deployments feature for engine-agnostic developers and automated build workflows.
With Deployments, you can do the following:
- Work with local configurations for Cloud Code and Remote Config.
- Add service configuration next to the game client code.
- Apply Git-like workflows to service configuration, for example, branch, merge, diff, tag.
- Map Environments to a repository branch and work in isolation.
- Manually deploy file configuration via the UGS CLI or Deployment window.
- Add a deploy step to your CI/CD pipeline for automated deployment.
Explore supported services for Deployments
The list below gives an overview of services and features that support Deployments:
- Cloud Code Scripts
- Cloud Code C# Modules
- Remote Config
- Economy
- Leaderboards
- Triggers
- Access
- Matchmaker
Explore supported services for the UGS CLI
The list below gives an overview of services you can interact with using the UGS CLI:
- Access
- Cloud Code
- Cloud Content Delivery
- Cloud Save
- Economy
- Environments
- Leaderboards
- Lobby
- Matchmaker
- Player and Unity Authentication
- Remote Config
- Scheduler
- Schema Registry
- Triggers
Note
In UGS CLI version 2.0.0 and later, the Economy service is deprecated and no longer supported. For more information, refer to Economy service status.