Unity Editor and project commands for the Unity CLI
Install and manage Unity Editors and modules, open and manage projects, build and test projects, and control running Editors from the Unity CLI.
Read time 7 minutesLast updated 2 days ago
Use these commands to install and manage Unity Editor versions and modules, open and register projects, run builds and tests, and send commands to a running Editor. To control a running Editor from the CLI, install the Unity Pipeline package first.
Editors and modules
Command | Alias | Description |
|---|---|---|
| | Installs a Unity Editor version, optionally with modules. |
| | Adds modules to an installed Editor version. |
| | Removes an installed Editor version. |
| | Lists available releases and installed Editors, adds local installs, sets the default Editor, upgrades Editors, lists running instances, and prunes unused or missing Editors. |
| Manages a single installation of a Editor version. For example use | |
| | Shows or changes the path where the CLI installs Editors. |
| Lists available modules for an Editor version ( | |
| Lists available Unity releases from the release feed. | |
| Installs the Unity Hub desktop application ( |
Projects, builds, and templates
Command | Alias | Description |
|---|---|---|
| Opens a Unity project in a compatible Editor version. | |
| Closes the Unity Editor that has a project open. Neither the default nor | |
| | Manages registered Unity projects: list, create, clone, open, link, pin, report disk size, and close. |
| | Lists, inspects, creates, and manages project templates. |
| Inspects, exports, and imports Unity asset packages. | |
| Builds a project in batch mode with CI-friendly flags, including Android signing and export options. Use | |
| Runs a project in batch mode or runs a registered Editor command in headless mode with | |
| Recompiles a running Editor's scripts and reports compile errors, without a full build. | |
| Runs a project's Edit Mode and Play Mode tests through the Editor test runner and write an NUnit report. | |
| Watches a project and re-runs a command each time its files change. |
Connected Editors and AI agents
Command | Alias | Description |
|---|---|---|
| | Forwards a command to a connected Unity Editor, or list the commands a connected Editor exposes. |
| Lists every command and subcommand as a machine-readable manifest ( | |
| Lists every tool a connected Editor registers, with its parameter schema. | |
| | Installs, upgrades, and inspects the Unity pipeline package that connects the CLI to the Editor. |
| Shows the live state of connected Editors: port, project path, version, and process ID. | |
| Starts a Model Context Protocol (MCP) server for AI agents, or configures agent clients to use it. | |
| Manages detached Editor command jobs. | |
| Reads the Unity CLI agent skill, or installs it into an AI client. |
Install an Editor
Install a Unity Editor version, optionally with modules.
unity install [version] [options]
The argument is positional and optional:
version- On an interactive terminal, omitting the version opens an interactive prompt.
- On a non-interactive terminal (for example, a CI pipeline), omitting the version is an error.
Version aliases
Alias | Resolves to |
|---|---|
| The newest available Editor release. |
| The newest long-term support release. |
| The version configured as your default in the Unity CLI. |
| The newest release within that major or minor stream. |
Install options
Refer to for the complete list.
unity install --helpOption | Usage | Description |
|---|---|---|
| | Changeset for the chosen Editor, required when the version isn't in the release list. |
| | Module IDs to install alongside the Editor. Accepts multiple values. |
| | Also installs child modules of each selected module (for example, Android SDK & NDK under |
| | macOS only. Selects between Apple silicon and Intel builds. |
Install examples
unity install 6000.3.7f1unity install ltsunity install 6000.3.7f1 -c 9b001d489a54unity install 6000.3.7f1 -m android --cmunity install lts -m ios android webgl
Note
For available module IDs, refer to Add modules to a Unity Editor installation and the module ID table.
Install modules for an existing Editor
Add one or more modules to an Editor you already installed with the Hub or the CLI.
unity install-modules [options]
Important
You can only add modules to Editors that the Hub or CLI installed. Reinstall manually installed Editors through the Hub or CLI to add modules.
Install-modules options
Option | Required? | Description |
|---|---|---|
| No | Editor version to add the module to. If omitted on an interactive terminal, you receive a prompt. |
| No | Module ID(s) to install. Accepts multiple values. |
| No | Lists installable modules for the target Editor instead of installing anything. |
| No | Installs every available module for the target Editor. |
| No | Also installs child modules. Use |
Install-modules examples
unity install-modules -e 6000.3.7f1 -m ios androidunity install-modules -e 6000.3.7f1 -lunity install-modules -e 6000.3.7f1 --allunity install-modules -e 6000.3.7f1 -m android --no-cm
Uninstall an Editor
Remove an installed Editor version.
unity uninstall <version>
uninstall examples
unity uninstall 6000.3.7f1
List and manage Editors
Inspect available releases and installed Editors, register locally installed Editors with the Hub, and set a default version.
unity editors [options]unity editors add <path...>unity editors default [version]
Editor options
Option | Alias | Description |
|---|---|---|
| | Shows available releases. |
| | Shows Editors installed on this machine. |
| Includes additional detail in the output. | |
| | Sets Editor architecture (x86_64 or arm64) the default setting is "unknown". |
| N/A | Outputs the list in JSON format. |
| | Watches for editor changes and refresh output (press Ctrl-C to stop). |
| | Displays help for this command. |
Add an Editor
Register an Editor you installed outside the Hub so the Hub and CLI can manage it. Accepts one or more paths.
unity editors add /Applications/Unity/Hub/Editor/6000.3.7f1/Unity.appunity editors add "C:\Program Files\Unity\6000.3.7f1" "C:\Program Files\Unity\2022.3.40f1"
Identify the default Editor
Print the current default Editor, or set a new default by passing a version:
unity editors default # show the defaultunity editors default 6000.3.7f1 # set the default
Editor command examples
unity editors -r # list available releasesunity editors -i # list installed Editorsunity editors -a # combined list
Set or get the Editor install path
Show or change the directory where the CLI installs Unity Editors.
unity install-path [options]
Alias: . Run for the current option list, including flags to display or update the path.
ipunity install-path --helpOpen a project
Open a Unity project, resolving the Editor version declared by the project.
unity open <path>
You can omit the keyword when the first argument is a path:
openunity open ./MyProjectunity ./MyProject # equivalent
On macOS and Linux, add to keep the command running until the Editor exits. The command then exits with code 0 when the Editor exits cleanly, or 6 when it fails or crashes. isn't supported on Windows yet and exits with code 2.
--wait--waitManage projects in the Hub registry
Manage the list of Unity projects the Hub knows about, so both the Hub UI and the CLI can find and open them.
unity projects [subcommand] [options]
Alias: . Run to check the available commands and options in your installed CLI version.
punity projects --help