What's new in UGS CLI 2.0.0
UGS CLI 2.0.0 adds Unity Hub login, Observability and Purchasing commands, and new Cloud Code, Leaderboards, Matchmaker, and Triggers commands, and removes the Economy and Game Server Hosting modules.
阅读时间6 分钟最后更新于 3 天前
Discover new features and improvements in the latest version of the Unity Gaming Services (UGS) CLI. Version 2.0.0 includes breaking changes. Before you upgrade, review Moved and removed commands to update your scripts and CI/CD pipelines.
Log in with Unity Hub
You can now authenticate the CLI with the account signed in to Unity Hub, as an alternative to a service account.
- Use to log in with Unity Hub. Unity Hub must be running and signed in. You can't combine
ugs login --unity-hubwith the service account options.--unity-hub - Running without options now prompts you to choose a login method:
ugs loginorUnity Hub.Service Account - Set the environment variable to
UGS_CLI_USE_HUB_AUTHto use Unity Hub authentication for a single call without logging in.true
Authenticated calls use the first available credential, in this order:
UGS_CLI_AUTH_TOKENUGS_CLI_USE_HUB_AUTH- The credential saved by
ugs login - and
UGS_CLI_SERVICE_KEY_IDUGS_CLI_SERVICE_SECRET_KEY
ugs statusUGS_CLI_USE_HUB_AUTHugs statusugs logoutFor more information, refer to Get authenticated and Login.
Configuration priority and new environment variables
Options now take priority over environment variables, and environment variables take priority over local configuration. Use the new environment variable to override the directory where the CLI stores its configuration.
UGS_CLI_CONFIG_DIRFor more information, refer to Configuration keys.
Deploy and fetch Lobby and In-App Purchasing configurations
ugs deployugs fetch.lo.ucat.catalog.csvQuery logs with Observability commands
Use (alias ) to query your project's logs. Filter results with , , and , and page through them with and .
ugs observability logs listobs--from--to--query--offset--limitFor more information, refer to Observability.
Manage IAP catalogs with Purchasing commands
Use (alias ) to manage In-App Purchasing catalogs:
ugs purchasingiap- lists your catalog items.
ugs purchasing list - creates a
ugs purchasing new-file <file-name>catalog file. Add.ucatto create a--csvfile instead..catalog.csv
For more information, refer to Purchasing.
Manage Cloud Code module and script versions
- and
ugs cloud-code modules gethave a newugs cloud-code scripts getoption that lists retained versions.--versions - and
ugs cloud-code modules delete-versiondelete a specific version. You can't deleteugs cloud-code scripts delete-version, the live version, or a version assigned to a release.latest - retrieves a module's specification. Use
ugs cloud-code modules get-specto target a specific version.--version
Read and manage Leaderboards scores
New command groups let you read and manage leaderboard scores and buckets:
- and
ugs leaderboards buckets listugs leaderboards buckets scores - ,
ugs leaderboards scores list,get,get-range,get-by-player-ids, anddeletepurge
These commands support the , , , , , and options, depending on the command.
--offset--limit--tier--version--range-limit--player-idsFor more information, refer to Leaderboards.
Create Lobby configuration files
Use to create a configuration file, then deploy it with . This replaces the and commands.
ugs lobby new-file.lougs deployugs lobby importugs lobby exportInspect Matchmaker configuration
New Matchmaker commands:
The template now uses match hosting.
ugs matchmaker new-fileMatchIdMultiplay hosting is no longer supported. skips queues that use Multiplay hosting, and displays a warning for them.
ugs deployugs fetchInspect triggers and manage the dead letter queue
- retrieves a single trigger.
ugs triggers get <trigger-id> - ,
ugs triggers dlq list,get,discard,discard-all, andreplaymanage failed trigger events in the dead letter queue. Filterreplay-allresults withdlq list,--limit,--status,--created-from,--created-to, and--resolution-action.--event-id - Trigger configuration files support a new field.
ActionScopeType
For more information, refer to Triggers.
Create interval schedules
Scheduler configuration files support a new interval schedule type, in addition to recurring and one-time schedules. Use and to set when a schedule is active.
StartAtEndAtFor more information, refer to Scheduler new-file.
Moved and removed commands
Access commands moved to player-policy and project-policy
Access commands are now grouped under and . The commands now take statement IDs as arguments instead of a file.
player-policyproject-policydelete1.9.0 command and page | 2.0.0 replacement |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| Removed. Use |
The delete options schema is removed from the Access resource definition.
statementIDsLobby import and export removed
1.9.0 command and page | 2.0.0 replacement |
|---|---|
| |
| |
Economy module removed
The Economy module is decommissioned. All commands are removed, and and no longer support Economy files. There's no replacement in 2.0.0.
ugs economyugs deployugs fetchRemoved pages:
/services-cli/1.9.0/manual/economy/services-cli/1.9.0/manual/economy/commands/delete/services-cli/1.9.0/manual/economy/commands/get-published/services-cli/1.9.0/manual/economy/commands/get-resources/services-cli/1.9.0/manual/economy/commands/new-file/services-cli/1.9.0/manual/economy/commands/publish
Game Server Hosting commands removed
The Game Server Hosting (Multiplay Hosting) service is decommissioned. All commands are removed, including the build, build configuration, core dump, fleet, fleet region, machine, server, and simulator commands. There's no replacement in 2.0.0.
ugs game-server-hostingThe pages under have no 2.0.0 equivalent.
/services-cli/1.9.0/manual/game-server-hostingSchema Registry pages removed
The Schema Registry commands were never included in a released version of the CLI. The 1.9.0 pages under documented them by mistake, and have no 2.0.0 equivalent.
/services-cli/1.9.0/manual/schema-registry