Documentation

​
​

Development

User Acquisition

Monetization

Industry

Unity Gaming Services CLI

v1.5

Legacy
​
GitHub Repository

Unity Gaming Services CLI

v1.5

Legacy
​
​
​
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
    • Unity Build Automation
    • Docker
    • GitHub Actions
    • Jenkins
    • Installing the CLI from CI
  • 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
  • Triggers
  1. Overview

GitHub Actions

Learn how to integrate the CLI with GitHub Actions.
Read time 1 minute
Last updated 3 months ago
In your GitHub repository, create a 
.yml
file under 
.github/workflows
. You can use the following recipe in your 
.yml
file as an example. For more information, see the official GitHub Actions Documentation.
Sample Recipe:
name: UGS CLI GitHub Actions Demo## Choose what triggers your workflow, here it is triggered for every pushon: push## Setting environment variablesenv:  UGS_CLI_PROJECT_ID: "your-project-id"  UGS_CLI_SERVICE_KEY_ID: "your-service-key-id"  UGS_CLI_SERVICE_SECRET_KEY: "your-service-secret-key"## Setting the jobsjobs:  demo-cli:    ## You might want to change the runs-on depending on your needs    runs-on: ubuntu-latest    steps:    - name: Download CLI      run: curl -OL https://github.com/Unity-Technologies/unity-gaming-services-cli/releases/latest/download/ugs-linux-x64    - name: Test CLI Commands      run: |        chmod +x ./ugs-linux-x64        ./ugs-linux-x64 --version        ./ugs-linux-x64 config get project-id        ./ugs-linux-x64 status        ./ugs-linux-x64 env list        ./ugs-linux-x64 deploy <directory-with-service-configurations> -j
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.