Documentation

​
​

Development

User Acquisition

Monetization

Industry

Unity Gaming Services CLI

v1.4

Legacy
​
GitHub Repository

Unity Gaming Services CLI

v1.4

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
  • 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
  • Player
  • Remote Config
  • Scheduler
  • Triggers
  1. Overview

Commands for Deployment Definition

Use the deploy and fetch commands with a Deployment Definition.
Read time 2 minutes
Last updated 3 months ago

Supported Commands

Deployment Definition supports the following commands: 
deploy
, 
fetch
.

Deploy

Using the 
deploy
command on a Deployment Definition will deploy all files it contains. All files that are excluded will be ignored. The exclusion of these files will be logged.

Sample Output

Here is a sample output for the following Deployment Definition and file structure. The command used is 
ugs deploy Assets/DeployableAssets/CloudCode.ddef
.
{    "name": "CloudeCode",    "excludePaths": [        "**/Tests/**"    ]}
Assets/├── DeployableAssets/│   ├── CloudCode/│   │   ├── CloudCode.ddef│   │   ├── scriptA.js│   │   ├── scriptB.js│   │   └── Tests/│   │       ├── scriptA_test.js│   │       └── scriptB_test.js│   └── Remote Config/│       ├── RemoteConfig.ddef│       ├── configA.rc│       └── configB.rc
Here is the result
Successfully deployed the following files:    'Assets/DeployableAssets/CloudCode/scriptA.js'    'Assets/DeployableAssets/CloudCode/scriptB.js'Created:    'Assets/DeployableAssets/CloudCode/scriptA.js'    'Assets/DeployableAssets/CloudCode/scriptB.js'[Information]:    The following files were excluded by deployment definitions:        'Assets/DeployableAssets/CloudCode/Tests/scriptA_test.js' [CloudCode.ddef]        'Assets/DeployableAssets/CloudCode/Tests/scriptB_test.js' [CloudCode.ddef]

Fetch

Using the 
fetch
command on a Deployment Definition will fetch all files it contains. All files that are excluded will be ignored. The exclusion of these files will be logged.

Reconcile

Given that Deployment Definition files are local groupings for files and do no exist on the server, the 
--reconcile option
will not work for a Deployment Definition.

Sample Output

Here is a sample output for the following Deployment Definition and file structure. The command used is 
ugs deploy Assets/DeployableAssets/CloudCode.ddef
.
{    "name": "CloudeCode",    "excludePaths": [        "**/Tests/**"    ]}
Assets/├── DeployableAssets/│   ├── CloudCode/│   │   ├── CloudCode.ddef│   │   ├── scriptA.js│   │   ├── scriptB.js│   │   └── Tests/│   │       ├── scriptA_test.js│   │       └── scriptB_test.js│   └── Remote Config/│       ├── RemoteConfig.ddef│       ├── configA.rc│       └── configB.rc
Here is the result
Successfully fetched the following files:    'DeployableAssets/CloudCode/scriptA.js'    'DeployableAssets/CloudCode/scriptB.js'Updated:    'Assets/DeployableAssets/CloudCode/scriptA.js'    'Assets/DeployableAssets/CloudCode/scriptB.js'[Information]:    The following files were excluded by deployment definitions:        'Assets/DeployableAssets/CloudCode/Tests/scriptA_test.js' [CloudCode.ddef]        'Assets/DeployableAssets/CloudCode/Tests/scriptB_test.js' [CloudCode.ddef]
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

    • Supported Commands

    • Deploy

      • Sample Output

    • Fetch

      • Reconcile

      • Sample Output