Documentation

Unity command-line interface (CLI)

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 9 days ago

The Unity CLI is a standalone command-line tool for installing and managing Unity Editors and modules from a terminal. The Unity Hub installs the Unity CLI and updates it by default, but you can also install, update, and run the Unity CLI on its own. The Unity CLI is well suited for:
  • Continuous integration (CI) pipelines and build agents.
  • Scripting and automation that needs structured output (JSON or TSV) and predictable exit codes.
  • Users who prefer a terminal-first workflow for installing Editors, managing modules, and opening projects.
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.

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.