Welcome to the Unity Gaming Services - Command Line Interface UGS CLI - Beta Release discussion thread. You can use this thread to ask for help, share feedback and have discussions about the UGS CLI.
Introduction
Introducing the UGS CLI, a command line interface with a variety of tools to easily manage, test and deploy Unity Gaming Services configuration. The CLI provides a scalable and automatable alternative to the Unity Dashboard and can greatly improve your team workflow & productivity.
Getting started
-
To install and use the UGS CLI, follow the getting started documentation
-
Browse Samples on how to use Deployments
-
Examples on how to integrate UGS CLI as part of CI/CD tools
Complete documentation can be found on the GitHub repository.
Supported Services and Uses cases
Introducing Deployments
We are excited to introduce Config as Code workflow for Remote Config and Cloud Code.
You can now use the CLI to deploy file configurations using the deploy command, enabling easy integration into automated build pipelines (CI/CD).
This feature was already introduced by Remote Config and Cloud Code packages for Unity Editor, the CLI is now bringing these capabilities to engine agnostic Developers and automated build workflows.
With Deployments, you can easily:
- Work with local configurations for cloud code and remote config
- Add service configuration next to the game client code
- Apply git-like workflow to service configuration (branch, merge, diff, tag, etc…)
- Map Unity Environment to a repository branch and work in isolation
- Manually deploy file configuration via the CLI or Deployment Window
- Add a deploy step to your CI/CD pipeline for automated deployment
We are working on adding more Services to Deployments, please provide feedback on what services you want deployment to support next!
The UGS CLI gives you new ways to interact with the Lobby service and issue commands such as:
- Get lobbies information and update lobbies
- Create or Join lobbies
- Show list of lobbies that players are in
- Heartbeat a lobby to keep it active
- Request auth token for lobby integration
And more!
On top of using deploy to publish Cloud Code script, you can use the UGS CLI Cloud Code commands to easily interact with Admin APIs:
- List Cloud Code scripts
- Create / Update Cloud Code scripts
- Get Cloud Code scripts
- Delete Cloud Code scripts
- Publish Cloud Code scripts
Manage Dashboard environments directly from the CLI with the environment module.
- List Environment
- Create Environment
- Delete Environment
- Use Environment for CLI commands
Service Account and Role Based Access Control
Use Unity Service Account to create authorized users of the CLI with granular permissions control thanks to Role Based Access Control.
Feedback
At Unity, we put the Users First so your feedback is extremely valuable to us. Our team is dedicated to improving these tools and your feedback is essential to where we will go next. Please share your comments in this thread so that we can continue improving our tools for you!
How to report bugs
Please report any issue via this link.
Once you have submitted a bug report through the bug reporter, please feel free to start a discussion about it in this thread.
Thank you for your interest, we’re looking forward to your feedback!
