For installing the UGS CLI and getting started, see Getting Started.
The source code project is for reference only. You may not be able to build it due to lack of access to internal dependencies.
Install the CLI with npm by calling npm install -g ugs in your command line.
Download the executable directly from the GitHub releases.
On macos and linux, use chmod +x <path_to_executable> to mark the file as executable.
To see the full list of services and commands available in the UGS CLI, visit the documentation on https://services.docs.unity.com/guides/ugs-cli/latest/general/overview
An UGS CLI command has the following format:
ugs <command> <subcommand> [<arguments>] [options]
To get help and list all modules:
ugs --help
To get the version of the CLI:
ugs --version
Requires Windows 10 or later.
Requires Ubuntu, Alpine or most other major distros.
Requires Mac OS 10.15 or later.
Please Submit a Request if you need any help.