Unity Gaming Services CLI

Use the UGS CLI to manage Remote Config files from the command line.

Read time 1 minute

Last updated 4 days ago

You can use the Unity Gaming Services CLI to interact with Remote Config files. The CLI allows you to create, deploy, and manage Remote Config files from the command line.

Prerequisites

For a deep dive into the CLI, follow the steps in the Unity Gaming Services CLI Get Started guide. To follow this guide, you must first complete the following actions:

Install the UGS CLI.

Configure your Project ID and Environment as such:

ugs config set project-id <your-project-id>

ugs config set environment-name <your-environment-name>

Configure a Service Account with the required roles for Remote Config and environments management. Refer to Get Authenticated.

Using the CLI

Refer to the Remote Config Command Line documentation for a full reference of all commands and options.

Note

The

ugs remote-config

command is also available as

ugs rc

Deploy resources

Run the

new-file

command to create a resource locally:


ugs remote-config new-file <file-name>

You can use the

Deploy

command to promote your local resources to the remote environment and publish them at once. The local resources must be deployed to become available to the game client.


ugs deploy <path-to-file> <path-to-file>


ugs deploy <path-to-directory>

Retrieve resources

You can use the

Fetch

command to retrieve all the Remote Config keys from the remote into a single file. The provided path is a directory where the keys will be fetched to:


ugs fetch <path> --services remote-config

Environment synchronization

You can move all your modules from one environment and deploy them to another environment. Run the following command to produce an archive of all the modules in your current environment:


ugs remote-config export <out-dir> <file-name> --environment-name <environment-to>

You can then import the modules and deploy them to another environment by running the following command:


ugs remote-config import <in-dir> <file-name> --environment-name <environment-to>

Documentation

Development

User Acquisition

Monetization

Industry