Documentation

Unity command-line interface (CLI)

Unity Pipeline

Unity Hub

Download Unity Hub

Unity command-line interface (CLI)

Introduction to the Unity command-line interface (CLI)

Install, update, and use the Unity CLI to manage Unity Editors and modules from a terminal.
Read time 1 minuteLast updated a month ago
Note
The Unity CLI is experimental.
The Unity CLI is a standalone command-line tool for installing and managing Unity Editors and modules from a terminal. The Unity Hub now automatically installs the Unity CLI. Since it's distributed as its own binary, you can install, update, and also use it independently of the Unity Hub desktop application.
The Unity CLI is well suited for:
  • Continuous integration (CI) and build agents where installing the full Hub is undesirable.
  • Scripting and automation that needs structured output (JSON or TSV) and predictable exit codes.
  • Users who prefer a terminal-first workflow for everyday Hub tasks.
Note
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.
If you have existing scripts that use the Hub CLI's 
-- --headless
syntax, review the migration guide in the Unity CLI reference.
Use the Unity command-line interface (CLI)Install the CLI, update it, and complete common tasks such as installing Editors, adding modules, signing in, and opening projects.
Unity command-line interface (CLI) referenceFind commands, options, output formats, exit codes, and migration information for the Unity CLI.

Unity CLI introduction video

The following video gives an overview of the Unity CLI and how you can use it with the Unity Pipeline package.