Documentation

​
​

Development

User Acquisition

Monetization

Industry

Unity Gaming Services CLI

v1.9

Supported
​
GitHub Repository

Unity Gaming Services CLI

v1.9

Supported
​
​
​
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
  • Matchmaker
  • Player
  • Remote Config
  • Scheduler
  • Schema Registry
  • Triggers
  1. UGS CLI

Set up a Common Configuration

Set up a project-id and environment name to use with the CLI.
Read time 1 minute
Last updated 3 months 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.
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

    • Configure a Project ID

    • Configure an Environment Name