Documentation

Unity Gaming Services CLI


GitHub Repository

Unity Gaming Services CLI


Set up a Common Configuration

Set up a project-id and environment name to use with the CLI.
Read time 1 minuteLast updated 21 hours ago

Most service commands require a project-id and an environment name. Here is how to easily set them up.

Configure a Project ID

  1. Find your project ID in the UGS Dashboard at Projects > Select a project > Project ID.
  2. Call
    ugs config set project-id <your-project-id>
    to set the
    Project ID
    to use to make service calls.

Configure an Environment Name

  1. Find your environment in the UGS Dashboard at Projects > Select a project > Environments > Select an environment > Name.
  2. Call
    ugs config set environment-name <your-environment-name>
    to set the
    Environment Name
    to use to make service calls.
Note
You can also set your Project ID or Environment Name by setting UGS_CLI_PROJECT_ID or UGS_CLI_ENVIRONMENT_NAME as an environment variable in your system.