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

Troubleshooting Deployment Definition

Solve common issues when running commands against a Deployment Definition.
Read time 2 minutes
Last updated 3 months ago

Possible Errors

There are a few errors that can occur when trying to use commands with a Deployment Definition.
  1. File intersection.
    1. With another file.
    2. With an excluded file.
  2. Multiple Deployment Definitions in the same directory.

File intersection

Using a Deployment Definition is a separate logical grouping than files or directories.

With Another File

If the set of files a Deployment Definition is responsible for intersects with other items in the command, the following error will occur:
Command: 
ugs deploy Assets/DeployableAssets/CloudCode/CloudCode.ddef Assets/DeployableAssets/CloudCode/scriptA.js
Assets/├── DeployableAssets/│   ├── CloudCode/│   │   ├── CloudCode.ddef│   │   ├── scriptA.js│   │   ├── scriptB.js│   │   └── Tests/│   │       ├── scriptA_test.js│   │       └── scriptB_test.js
[Error]:    A conflict was found between the deployment definitions and the other arguments:        'Assets/DeployableAssets/CloudCode/scriptA.js' [CloudCode.ddef]

With an Excluded File

If the set of excluded files for a Deployment Definition intersects with other items in the command, the following error will occur:
Command: 
ugs deploy Assets/DeployableAssets/CloudCode/CloudCode.ddef Assets/DeployableAssets/CloudCode/scriptA.js
Assets/├── DeployableAssets/│   ├── CloudCode/│   │   ├── CloudCode.ddef│   │   ├── scriptA.js│   │   ├── scriptB.js│   │   └── Tests/│   │       ├── scriptA_test.js│   │       └── scriptB_test.js
[Error]:    A conflict was found between the deployment definition exclusions and the other arguments:        'Assets/DeployableAssets/CloudCode/Tests/scriptA_test.js' [CloudCode.ddef]

Multiple Deployment Definitions in a Directory

Given that a Deployment Definition is responsible for a whole directory, having multiple Deployment Definition in the same directory will cause an error when trying to execute a command that involves them.
Command: 
ugs deploy Assets/DeployableAssets/CloudCode/CloudCode.ddef Assets/DeployableAssets/CloudCode/scriptA.js
Assets/├── DeployableAssets/│   ├── CloudCode/│   │   ├── CloudCode1.ddef│   │   ├── CloudCode2.ddef│   │   ├── scriptA.js│   │   ├── scriptB.js│   │   └── Tests/│   │       ├── scriptA_test.js│   │       └── scriptB_test.js
[Error]:    Multiple deployment definitions were found in the directory 'Assets/DeployableAssets/CloudCode': 'CloudCode1.ddef' and 'CloudCode2.ddef'

Fetch with --reconcile

As mentioned in the commands page, it is not possible to use the 
--reconcile
with the fetch command when using Deployment Definition.
Attempting to do so will generate the following error message:
[Error]:    Reconcile is not compatible with Deployment Definitions
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

    • Possible Errors

    • File intersection

      • With Another File

      • With an Excluded File

    • Multiple Deployment Definitions in a Directory

    • Fetch with --reconcile