Unity CLI reference

Explore the Unity CLI commands, options, output formats, and exit codes you can use to install and manage Unity Editors and modules from a terminal.

Read time 1 minute

Last updated 2 days ago

Find the commands and options available in the Unity command-line interface (CLI). For installation and common task instructions, refer to Use the Unity CLI. To use the Unity CLI to control the Unity Editor, install and set up the Unity Pipeline package. For an example of how you can use the Unity CLI with Unity Pipeline, refer to the Unity CLI introduction video.

Run unity --help to check the authoritative command list for your installed version, including any commands not yet covered on this page.

Unity Editor and project commandsInstall and manage Unity Editors and modules, open and manage projects, build and test projects, and control running Editors from the Unity CLI.

Unity account, license, cloud, and collaboration commandsSign in to your Unity account, authenticate with a service account, manage licenses, and work with Unity Cloud organizations, projects, and collaboration from the Unity CLI.

Version control commandsManage version control for Unity projects with Git, Git providers, and Unity Version Control (UVCS), including commands for asset integrity checks, scene and prefab merges, resolving conflicts, and change analysis.

Output formats and automationConfigure Unity CLI output formats, handle errors and exit codes, and use environment variables to control CLI behavior in scripts, Continuous Integration (CI) pipelines, and agent workflows.

Unity CLI configuration, diagnostics, and maintenance commandsConfigure Unity CLI settings, troubleshoot issues with diagnostics and logs, and update, inspect, or uninstall the Unity CLI.

Migrate from the Hub CLIMigrate scripts and CI pipelines from the Unity Hub CLI to the Unity CLI by comparing syntax, flags, output formats, exit codes, and identify breaking changes.