### Install Editor examples Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Examples of installing Editors with version aliases, changesets, modules, and child modules. ```bash unity install 6000.3.7f1 unity install lts unity install 6000.3.7f1 -c 9b001d489a54 unity install 6000.3.7f1 -m android --cm unity install lts -m ios android webgl ``` -------------------------------- ### Install-modules examples Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Examples of adding modules, listing installable modules, installing all modules, and skipping child modules. ```bash unity install-modules -e 6000.3.7f1 -m ios android unity install-modules -e 6000.3.7f1 -l unity install-modules -e 6000.3.7f1 --all unity install-modules -e 6000.3.7f1 -m android --no-cm ``` -------------------------------- ### Install Unity Hub (hub install) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Example usage of the hub command to install the Unity Hub desktop application. ```bash hub install ``` -------------------------------- ### Install Unity Hub (hub) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Installs the Unity Hub desktop application. Example: 'hub install'. ```bash hub ``` -------------------------------- ### Editor Command Examples: unity editors -r/-i/-a Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Examples of the unity editors command: -r lists available releases, -i lists installed Editors, and -a shows a combined list. ```bash unity editors -r # list available releases unity editors -i # list installed Editors unity editors -a # combined list ``` -------------------------------- ### Install Unity Editor (install) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Installs a Unity Editor version, optionally with modules. Alias: i. ```bash install ``` -------------------------------- ### Install alias (i) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Alias for the install command. ```bash i ``` -------------------------------- ### Hub CLI progress output example Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Example of Hub CLI progress output as plain text lines. ```text downloading 23.50% ``` -------------------------------- ### Install a Unity Editor with unity install Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Installs a Unity Editor version, optionally with modules. The version argument is positional and optional; omitting it opens an interactive prompt on an interactive terminal and is an error on a non-interactive terminal. ```bash unity install [version] [options] ``` -------------------------------- ### Set up version control with vcs setup Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Sets up a project from no version control to its first commit on a remote. Asks only what it can't detect and prints the equivalent flag command. ```bash vcs setup ``` -------------------------------- ### Set or Get Editor Install Path: unity install-path Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Shows or changes the directory where the CLI installs Unity Editors. Alias: ip. Run unity install-path --help for the current option list. ```bash unity install-path [options] ``` -------------------------------- ### List modules for version (modules list) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Example usage of the modules command to list available modules for a specific Editor version. ```bash modules list ``` -------------------------------- ### Uninstall Editor Example: unity uninstall 6000.3.7f1 Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Example that uninstalls Editor version 6000.3.7f1. ```bash unity uninstall 6000.3.7f1 ``` -------------------------------- ### List and Manage Editors: unity editors commands Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Lists available releases and installed Editors, registers locally installed Editors with the Hub, and sets a default version. Use the subcommands add and default with the options shown in the table. ```bash unity editors [options] unity editors add unity editors default [version] ``` -------------------------------- ### Install modules (install-modules) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Adds modules to an installed Editor version. Alias: im. ```bash install-modules ``` -------------------------------- ### Show or change install path (install-path) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Shows or changes the path where the CLI installs Editors. Alias: ip. ```bash install-path ``` -------------------------------- ### Start MCP server with mcp Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Starts a Model Context Protocol (MCP) server for AI agents, or configures agent clients to use it. mcp configure --server issue-tracker configures the Unity Issue Tracker MCP server. ```bash mcp ``` -------------------------------- ### Install modules for an existing Editor with unity install-modules Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Adds modules to an Editor already installed with the Hub or CLI. Only Editors installed by the Hub or CLI can be modified. ```bash unity install-modules [options] ``` -------------------------------- ### Manage Unity Cloud (cloud) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Shows cloud sign-in state, organizations, and Unity Cloud projects, and creates organizations. Example: 'cloud org create'. ```bash cloud ``` -------------------------------- ### Manage single Editor (editor) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Manages a single installation of an Editor version. For example, use 'editor module remove' to remove installed modules on a specific Editor version. ```bash editor ``` -------------------------------- ### Open Project Examples: unity open and shorthand Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Shows that the open keyword is optional when the first argument is a path. On macOS and Linux, add --wait to keep the command running until the Editor exits; --wait isn't supported on Windows yet and exits with code 2. ```bash unity open ./MyProject unity ./MyProject # equivalent ``` -------------------------------- ### Unity CLI install version positional argument Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Unity CLI optional positional argument for the editor version with the 'install' command. ```text [version] ``` -------------------------------- ### Replace install -v with positional version Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Hub CLI install command with version flag that should be replaced with 'install ' (positional) in scripts. ```text install -v ``` -------------------------------- ### List modules (modules) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Lists available modules for an Editor version. Example: 'modules list '. ```bash modules ``` -------------------------------- ### Manage Editors (editors) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Lists available releases and installed Editors, adds local installs, sets the default Editor, upgrades Editors, lists running instances, and prunes unused or missing Editors. Alias: e. ```bash editors ``` -------------------------------- ### Update the CLI with unity self-update Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Installs the latest CLI release. The command resumes an interrupted download instead of starting over. ```bash unity self-update ``` -------------------------------- ### Read or install agent skill with skill Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Reads the Unity CLI agent skill, or installs it into an AI client. ```bash skill ``` -------------------------------- ### Add an Editor: unity editors add Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Registers Editors installed outside the Hub so the Hub and CLI can manage them. Accepts one or more paths; examples show macOS and Windows paths. ```bash unity editors add /Applications/Unity/Hub/Editor/6000.3.7f1/Unity.app unity editors add "C:\Program Files\Unity\6000.3.7f1" "C:\Program Files\Unity\2022.3.40f1" ``` -------------------------------- ### Uninstall an Editor: unity uninstall Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Removes an installed Editor version. Replace with the exact version string, for example 6000.3.7f1. ```bash unity uninstall ``` -------------------------------- ### Install path alias (ip) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Alias for the install-path command. ```bash ip ``` -------------------------------- ### Hub CLI install version flags Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Hub CLI flags for specifying the editor version with the 'install' command. The version flag is required. ```text --version ``` ```text -v ``` -------------------------------- ### Remove Editor modules (editor module remove) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Example usage of the editor command to remove installed modules on a specific Editor version. ```bash editor module remove ``` -------------------------------- ### Show Unity CLI help Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Run this command to check the authoritative command list for your installed Unity CLI version, including any commands not yet covered on this page. ```bash unity --help ``` -------------------------------- ### Install modules alias (im) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Alias for the install-modules command. ```bash im ``` -------------------------------- ### Unity CLI invocation Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Invocation of the Unity CLI. Standalone binary; no Hub installation required. ```text unity ``` -------------------------------- ### Editor Options: unity editors flags Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Options for the unity editors command. --releases/-r shows available releases, --installed/-i shows installed Editors, --verbose adds detail, --architecture sets x86_64 or arm64 (default unknown), --json outputs JSON, --watch/-w refreshes on changes (press Ctrl-C to stop), and --help/-h displays help. ```bash --releases ``` ```bash -r ``` ```bash --installed ``` ```bash -i ``` ```bash --verbose ``` ```bash --architecture ``` ```bash -a ``` ```bash --json ``` ```bash --watch ``` ```bash -w ``` ```bash --help ``` ```bash -h ``` -------------------------------- ### Uninstall Unity Editor (uninstall) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Removes an installed Editor version. Alias: u. ```bash uninstall ``` -------------------------------- ### Manage pipeline package with pipeline Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Installs, upgrades, and inspects the Unity pipeline package that connects the CLI to the Editor. pipeline cloud-build and pipeline automation read Unity Build Automation and Unity Pipeline Automation. Alias: pipe. ```bash pipeline ``` -------------------------------- ### Manage Git hooks with vcs hooks Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Installs or removes Git hooks that run Unity integrity checks on your commits. ```bash vcs hooks ``` -------------------------------- ### Show install-path Help: unity install-path --help Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Displays the current option list for the install-path command, including flags to display or update the path. ```bash unity install-path --help ``` -------------------------------- ### Create cloud organization (cloud org create) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Creates a Unity Cloud organization. ```bash cloud org create ``` -------------------------------- ### Configure Unity merge with vcs merge-setup Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Configures Unity scene and prefab merging (UnityYAMLMerge) for the repository. ```bash vcs merge-setup ``` -------------------------------- ### Build project (build) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Builds a project in batch mode with CI-friendly flags, including Android signing and export options. Use --list-targets, --list-profiles, and --create-profile to discover targets and create Unity 6 build profiles, and 'build run' to launch the project's most recent recorded build. ```bash build ``` -------------------------------- ### List build profiles (--list-profiles) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Flag for the build command to list available build profiles. ```bash --list-profiles ``` -------------------------------- ### Open Unity project (open) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Opens a Unity project in a compatible Editor version. ```bash open ``` -------------------------------- ### Manage licenses (license) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Lists, activates, and returns Unity licenses on this machine. ```bash license ``` -------------------------------- ### Run recorded build (build run) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Launches the project's most recent recorded build. ```bash build run ``` -------------------------------- ### List commands manifest with commands Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Lists every command and subcommand as a machine-readable manifest (--format json) for agents and tooling. ```bash commands ``` -------------------------------- ### Print bare version string with unity --version Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Prints only the version string. The flag ends option parsing, so a machine format must be set before it. ```bash unity --version ``` -------------------------------- ### Create build profile (--create-profile) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Flag for the build command to create a Unity 6 build profile for a target. ```bash --create-profile ``` -------------------------------- ### Open a Project: unity open Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Opens a Unity project, resolving the Editor version declared by the project. The open keyword can be omitted when the first argument is a path. ```bash unity open ``` -------------------------------- ### Manage projects (projects) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Manages registered Unity projects: list, create, clone, open, link, pin, report disk size, and close. Alias: p. ```bash projects ``` -------------------------------- ### List build targets (--list-targets) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Flag for the build command to list available build targets. ```bash --list-targets ``` -------------------------------- ### Manage Projects in Hub Registry: unity projects Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Manages the list of Unity projects the Hub knows about. Alias: p. Run unity projects --help to check available commands and options. ```bash unity projects [subcommand] [options] ``` -------------------------------- ### Print structured version with unity --format json --version Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Sets the machine format before the --version flag to print the structured version object instead of the bare string. ```bash unity --format json --version ``` -------------------------------- ### Run project (run) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Runs a project in batch mode or runs a registered Editor command in headless mode with --command. Use --log-file to write the Editor log to a file. ```bash run ``` -------------------------------- ### Print structured version via UNITY_FORMAT=json unity --version Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Uses the UNITY_FORMAT environment variable to print the structured version object with --version. ```bash UNITY_FORMAT=json unity --version ``` -------------------------------- ### Print CLI version as JSON with unity version --format json Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Prints the CLI's version, release channel, commit, platform, architecture, and runtime as one object in JSON format. ```bash unity version --format json ``` -------------------------------- ### Unity CLI path shorthand Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Path shorthand in the Unity CLI that is equivalent to 'unity open ./MyProject'. ```text unity ./MyProject ``` -------------------------------- ### Explain conflict sides with vcs explain Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Explains in plain language what each side of a conflict changed. ```bash vcs explain ``` -------------------------------- ### Unity CLI --help flag Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Unity CLI replaces the Hub CLI 'help' command with the --help flag on every command. ```text --help ``` -------------------------------- ### Unity CLI install-modules module flag Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Unity CLI optional flag for specifying the module with the 'install-modules' command. ```text -m, --module ``` -------------------------------- ### List Editor tools with list Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Lists every tool a connected Editor registers, with its parameter schema. ```bash list ``` -------------------------------- ### Unity CLI default output when piped Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Default output format of the Unity CLI when piped. ```text tsv ``` -------------------------------- ### List Unity releases (releases) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Lists available Unity releases from the release feed. ```bash releases ``` -------------------------------- ### Import asset package (assets import) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Imports a .unitypackage into a project. ```bash assets import ``` -------------------------------- ### Authenticate (auth) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Sign in, check login state, or sign out. Alias: a. ```bash auth ``` -------------------------------- ### Inspect asset package (assets inspect) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Lists the contents of a .unitypackage without importing it. ```bash assets inspect ``` -------------------------------- ### Unity CLI install-modules editor version flag Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Unity CLI optional flag for specifying the editor version with the 'install-modules' command. ```text -e, --editor-version ``` -------------------------------- ### Watch project (watch) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Watches a project and re-runs a command each time its files change. 'watch test' re-runs 'unity test --affected'. ```bash watch ``` -------------------------------- ### Unity CLI --format json flag Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Unity CLI global flag for structured output. The --json flag is kept for compatibility. ```text --format json ``` -------------------------------- ### Sign In and Out: unity auth commands Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Manages your Unity account session. login opens a browser-based sign-in flow, status prints the current signed-in user, and logout signs out. ```bash unity auth login unity auth status unity auth logout ``` -------------------------------- ### Show or change CLI display language Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Shows the current CLI display language or changes it to a supported language. Use the alias 'lang' and run 'unity language --help' for supported languages and exact option names. ```bash unity language [options] ``` -------------------------------- ### Export assets (assets export) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Writes project assets to a .unitypackage. ```bash assets export ``` -------------------------------- ### Manage templates (templates) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Lists, inspects, creates, and manages project templates. Alias: t. ```bash templates ``` -------------------------------- ### Hub CLI install-modules module flags Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Hub CLI flags for specifying the module with the 'install-modules' command. The module flag is required. ```text --module ``` ```text -m ``` -------------------------------- ### Show Editor status with status Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Shows the live state of connected Editors: port, project path, version, and process ID. ```bash status ``` -------------------------------- ### Write Editor log (--log-file) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Flag for the run command to write the Editor log to a file. ```bash --log-file ``` -------------------------------- ### Summarize branch changes with vcs summarize Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Summarizes branch changes so you can paste them into a pull request. ```bash vcs summarize ``` -------------------------------- ### Show Unity-aware status with vcs status Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Shows changes grouped by their meaning to Unity, including .meta file pairing problems. ```bash vcs status ``` -------------------------------- ### Watch tests (watch test) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Re-runs 'unity test --affected' when files change. ```bash watch test ``` -------------------------------- ### Projects alias (p) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Alias for the projects command. ```bash p ``` -------------------------------- ### Run tests (test) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Runs a project's Edit Mode and Play Mode tests through the Editor test runner and writes an NUnit report. ```bash test ``` -------------------------------- ### Replace install-modules version flags Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Hub CLI install-modules version flags that should be replaced with '--editor-version' / '-e' in scripts. ```text install-modules --version ``` ```text -v ``` -------------------------------- ### Forward command to Editor with command Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Forwards a command to a connected Unity Editor, or lists the commands a connected Editor exposes. Alias: cmd. ```bash command ``` -------------------------------- ### Select output format with --format Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Selects an explicit output format with the global --format flag. The json format is for single buffered results, tsv for tab-separated machine-parseable output, and ndjson for streamed progress frames from long-running commands. ```bash unity editors -i --format json unity editors -i --format tsv unity install lts --format ndjson ``` -------------------------------- ### Report Git providers with vcs providers Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Reports which Git providers this machine can reach, as whom, and what each host allows. ```bash vcs providers ``` -------------------------------- ### Manage assets (assets) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Inspects, exports, and imports Unity asset packages. 'assets inspect ' lists the contents of a .unitypackage without importing it, 'assets export' writes project assets to a .unitypackage, and 'assets import ' imports one into a project. ```bash assets ``` -------------------------------- ### Run Unity VCS command group Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Runs the version control command group. Covers Git, GitHub, GitLab, self-hosted Git, and Unity Version Control (UVCS). It is separate from Unity Collaboration. ```bash unity vcs ``` -------------------------------- ### New Unity CLI commands Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Unity CLI commands that are not available in the Hub CLI. ```text auth ``` ```text open ``` ```text projects ``` ```text uninstall ``` ```text self-update ``` ```text build ``` ```text test ``` ```text license ``` ```text shell ``` ```text mcp ``` -------------------------------- ### Windows log directory path Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Default log directory path on Windows for the Unity CLI log file. ```text %UserProfile%\AppData\Roaming\UnityHub\logs ``` -------------------------------- ### Auth alias (a) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Alias for the auth command. ```bash a ``` -------------------------------- ### Switch branches with vcs switch Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Switches branches safely and reports the impact before you switch. ```bash vcs switch ``` -------------------------------- ### Diff scenes by name with vcs diff Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Compares a scene or prefab by GameObject and component name rather than by fileID. ```bash vcs diff ``` -------------------------------- ### Hub CLI --json flag Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Hub CLI flag for structured output per command (where supported). ```text --json ``` -------------------------------- ### Replace -- --headless invocation Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Hub CLI invocation pattern that should be replaced with 'unity' in scripts. ```text -- --headless ``` -------------------------------- ### Manage Collaboration (collaboration) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Manages Unity Collaboration annotations, attachments, thumbnails, and reactions, and links Jira issues to them. Alias: collab. ```bash collaboration ``` -------------------------------- ### Auth Subcommands: unity auth commands Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Auth subcommands: login opens a browser-based sign-in flow, status prints the current signed-in user, logout signs out, consumers lists applications that used your sign-in, and revoke stops an application from using your sign-in (pass --restore to undo). ```bash unity auth login ``` ```bash unity auth status ``` ```bash unity auth logout ``` ```bash unity auth consumers ``` ```bash unity auth revoke ``` -------------------------------- ### Linux log directory path Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Default log directory path on Linux for the Unity CLI log file. ```text ~/.config/UnityHub/logs ``` -------------------------------- ### Run Editor command (--command) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Flag for the run command to run a registered Editor command in headless mode. ```bash --command ``` -------------------------------- ### Unity CLI editors add command Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Unity CLI command to add local Editors as a command that accepts multiple paths. ```text editors add ``` -------------------------------- ### Uninstall alias (u) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Alias for the uninstall command. ```bash u ``` -------------------------------- ### Access UVCS reads with vcs uvcs Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Unity Version Control reads, including uvcs locks, uvcs changesets, and uvcs review. ```bash vcs uvcs ``` -------------------------------- ### Alias for self-update: unity upgrade Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Working alias for unity self-update, so existing scripts keep running. ```bash unity upgrade ``` -------------------------------- ### Replace editors --add with editors add Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Hub CLI editors add flag that should be replaced with 'editors add' in scripts. ```text editors --add ``` -------------------------------- ### Identify the Default Editor: unity editors default Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Prints the current default Editor when no version is given, or sets a new default by passing a version. ```bash unity editors default # show the default unity editors default 6000.3.7f1 # set the default ``` -------------------------------- ### Check repository health with vcs doctor Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Checks the repository settings, ignore rules, and LFS configuration a Unity project needs. The --fix flag repairs what it can. ```bash vcs doctor ``` -------------------------------- ### Unity CLI default output on interactive terminal Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Default output format of the Unity CLI on an interactive terminal. ```text human ``` -------------------------------- ### Run affected tests (unity test --affected) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Command re-run by 'watch test' when files change. ```bash unity test --affected ``` -------------------------------- ### macOS log directory path Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Default log directory path on macOS for the Unity CLI log file. ```text ~/Library/Application Support/UnityHub/logs ``` -------------------------------- ### Access Git-only verbs with vcs git Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Git-only verbs, including git worktree and git migrate-lfs. ```bash vcs git ``` -------------------------------- ### Blame GameObjects with vcs blame Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Shows who last changed each GameObject and component in a scene or prefab. ```bash vcs blame ``` -------------------------------- ### Unity CLI -V version flag Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference In the Unity CLI, the -V flag prints the CLI version. The -v flag is reserved and not used for editor version. ```text -V ``` -------------------------------- ### Hub CLI editors add command Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Hub CLI command to add a local Editor using a flag. ```text editors --add ``` -------------------------------- ### Safely sync with vcs sync Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Pulls safely: refuses while an Editor holds the project, fetches commits and LFS objects, then reports the reimport. ```bash vcs sync ``` -------------------------------- ### Manage Editor jobs with job Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Manages detached Editor command jobs. ```bash job ``` -------------------------------- ### Strict recompile (--strict) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Flag for the recompile command that also fails on warnings. ```bash --strict ``` -------------------------------- ### Collaboration alias (collab) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Alias for the collaboration command. ```bash collab ``` -------------------------------- ### Removed Hub CLI global flags Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Hub CLI global flags that have no equivalent in the Unity CLI. ```text --headless ``` ```text --errors ``` ```text --silent ``` ```text --logLevel ``` ```text -l ``` ```text --bugReporter ``` ```text --debugMode ``` ```text --inspect ``` ```text --userEmail ``` ```text --theme ``` ```text --editorLicense ``` ```text --servicesUrlInterval ``` ```text --cloudEnvironment ``` -------------------------------- ### Recompile scripts (recompile) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Recompiles a running Editor's scripts and reports compile errors, without a full build. --strict also fails on warnings. ```bash recompile ``` -------------------------------- ### CLI log file name Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference The CLI writes its log file named cli-log.json in the shared Unity Hub logs directory. Use the 'unity logs' command to read and follow it, or include it in a diagnostic snapshot with 'unity doctor'. ```text cli-log.json ``` -------------------------------- ### Report affected items with vcs affected Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Reports which assets, assemblies, and tests a change affects. Reports a lower bound when applicable. ```bash vcs affected ``` -------------------------------- ### Hub CLI exit codes Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Hub CLI exit codes: 0 for success, 1 for error. ```text 0 ``` ```text 1 ``` -------------------------------- ### Resolve conflicts with vcs resolve Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Resolves a conflicted Unity asset using the Editor's own merge tool. ```bash vcs resolve ``` -------------------------------- ### Hub CLI invocation Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Invocation of the Hub CLI embedded in the Unity Hub desktop application. Requires the full Unity Hub desktop application. ```text "Unity Hub.exe" -- --headless ``` -------------------------------- ### Capture both output streams to a log Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Captures both stdout and stderr to a log file in a shell. Errors and diagnostics go to stderr, leaving stdout for data output. ```bash unity install 6000.3.7f1 > install.log 2>&1 ``` -------------------------------- ### List merge conflicts with vcs conflicts Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Lists unresolved merge conflicts, classified by whether they can merge automatically. ```bash vcs conflicts ``` -------------------------------- ### Close Unity Editor (close) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Closes the Unity Editor that has a project open. Neither the default nor --force saves your work. ```bash close ``` -------------------------------- ### Templates alias (t) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Alias for the templates command. ```bash t ``` -------------------------------- ### Unity CLI json and ndjson modes Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Unity CLI output modes where a failed result remains on stdout, so branch on its error code rather than the stream. ```text json ``` ```text ndjson ``` -------------------------------- ### Force close flag (--force) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Flag used with the close command. Neither the default nor --force saves your work. ```bash --force ``` -------------------------------- ### Hub CLI error output stream Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Hub CLI writes errors to stdout. ```text stdout ``` -------------------------------- ### Editors alias (e) Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Alias for the editors command. ```bash e ``` -------------------------------- ### Unity CLI error output stream Source: https://docs.unity.com/en-us/unity-cli/unity-cli-reference Unity CLI writes diagnostic text to stderr. In json and ndjson modes, the failed result is still on stdout. ```text stderr ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.