JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1344
  • Score
    100M100P100Q117523F
  • License MIT

A command line utility for the Unity Game Engine.

Package Exports

  • @rage-against-the-pixel/unity-cli
  • @rage-against-the-pixel/unity-cli/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@rage-against-the-pixel/unity-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

unity-cli

Discord NPM Version NPM Downloads

A powerful command line utility for the Unity Game Engine. Automate Unity project setup, editor installation, license management, building, and more—ideal for CI/CD pipelines and developer workflows.

Table of Contents

Features

  • Install and manage Unity Hub and Unity Editors (multi-platform)
  • Activate and return Unity licenses (personal, professional, floating)
  • Create new Unity projects from templates
  • Run Unity Editor commands and builds from the CLI
  • Supports all modules, architectures, and build targets
  • Works on Windows, macOS, and Linux
  • Designed for automation and CI/CD

Installation

npm install -g @rage-against-the-pixel/unity-cli

Usage

In general, the command structure is:

unity-cli [command] {options} <args...>

With options always using double dashes (--option) and arguments passed directly to Unity or Unity Hub commands as they normally would with single dashes (-arg). Each option typically has a short alias using a single dash (-o), except for commands where we pass through arguments, as those get confused by the command parser.

Common Commands

  • unity-cli --help for a full list of commands and options.
  • unity-cli [command] --help for details on a specific command.
  • unity-cli [command] --json to get the output in JSON format (if supported).
  • unity-cli [command] --verbose <args...> to enable verbose logging for debugging.

[!IMPORTANT] <args...> must always be the last parameters passed to the command when using any command options.

unity-cli --help

Auth

License Version

license-version: Print the Unity License Client version.

unity-cli license-version
Activate License

activate-license [options]: Activate a Unity license.

  • -l, --license: License type (personal, professional, floating). Required.
  • -e, --email: Email associated with the Unity account. Required when activating a personal or professional license.
  • -p, --password: Password for the Unity account. Required when activating a personal or professional license.
  • -s, --serial: License serial number. Required when activating a professional license.
  • -c, --config: Path to the configuration file, or base64 encoded JSON string. Required when activating a floating license.
  • --verbose: Enable verbose output.
unity-cli activate-license --license personal --email <your-email> --password <your-password>
Return License

return-license [options]: Return a Unity license.

  • -l, --license: License type (personal, professional, floating)
  • --verbose: Enable verbose output.
unity-cli return-license --license personal

Unity Hub

Hub Version

hub-version: Print the Unity Hub version.

unity-cli hub-version
Hub Path

hub-path: Print the Unity Hub executable path.

unity-cli hub-path
Unity Hub Install

hub-install [options]: Install or update the Unity Hub

  • --auto-update: Automatically updates the Unity Hub if it is already installed. Cannot be used with --hub-version.
  • --hub-version: Specify to install a specific version of Unity Hub. Cannot be used with --auto-update.
  • --verbose: Enable verbose output.
  • --json: Output installation information in JSON format.
unity-cli hub-install
Run Unity Hub Commands

hub [options] <args...>: Run Unity Hub command line arguments (passes args directly to the hub executable).

  • --verbose: Enable verbose output.
  • <args...>: Arguments to pass directly to the Unity Hub executable.

Lists available Unity Hub commands:

unity-cli --verbose hub help

Gets a list of installed editors:

unity-cli hub editors --installed

Unity Editor

Setup Unity Editor

setup-unity [options]: Find or install the Unity Editor for a project or specific version.

  • -p, --unity-project <unityProject> The path to a Unity project or none to skip project detection.
  • -u, --unity-version <unityVersion> The Unity version to get (e.g. 2020.3.1f1, 2021.x, 2022.1.*, 6000). If specified, it will override the version read from the project.
  • -c, --changeset <changeset> The Unity changeset to get (e.g. 1234567890ab).
  • -a, --arch <arch> The Unity architecture to get (e.g. x86_64, arm64). Defaults to the architecture of the current process.
  • -b, --build-targets <buildTargets> The Unity build target to get/install as comma-separated values (e.g. iOS,Android).
  • -m, --modules <modules> The Unity module to get/install as comma-separated values (e.g. ios,android).
  • -i, --install-path <installPath> The path to install the Unity Editor to. By default, it will be installed to the default Unity Hub location.
  • --verbose Enable verbose logging.
  • --json Prints the last line of output as JSON string.

Installs the latest Unity 6 version with Android and iOS modules:

unity-cli setup-unity --unity-version 6000 --modules android,ios
Uninstall Unity Editor

uninstall-unity [options]: Uninstall a Unity Editor version.

  • -e, --unity-editor <unityEditor> The path to the Unity Editor executable. If unspecified, -u, --unity-version or the UNITY_EDITOR_PATH environment variable must be set.
  • -u, --unity-version <unityVersion> The Unity version to get (e.g. 2020.3.1f1, 2021.x, 2022.1.*, 6000). If unspecified, then --unity-editor must be specified.
  • -c, --changeset <changeset> The Unity changeset to get (e.g. 1234567890ab).
  • -a, --arch <arch> The Unity architecture to get (e.g. x86_64, arm64). Defaults to the architecture of the current process.
  • --verbose Enable verbose logging.
unity-cli uninstall-unity --unity-version 6000
List Project Templates

[!NOTE] Regex patterns are supported for the --template option. For example, to create a 3D project with either the standard or cross-platform template, you can use com.unity.template.3d(-cross-platform)?.

list-project-templates [options]: List available Unity project templates for an editor.

  • -e, --unity-editor <unityEditor> The path to the Unity Editor executable. If unspecified, -u, --unity-version or the UNITY_EDITOR_PATH environment variable must be set.
  • -u, --unity-version <unityVersion> The Unity version to get (e.g. 2020.3.1f1, 2021.x, 2022.1.*, 6000). If unspecified, then --unity-editor must be specified.
  • -c, --changeset <changeset> The Unity changeset to get (e.g. 1234567890ab).
  • -a, --arch <arch> The Unity architecture to get (e.g. x86_64, arm64). Defaults to the architecture of the current process.
  • --verbose Enable verbose logging.
  • --json Prints the last line of output as JSON string.

Lists available project templates for Unity 6:

unity-cli list-project-templates --unity-version 6000
Create Unity Project

create-project [options]: Create a new Unity project from a template.

  • -n, --name <projectName> The name of the new Unity project. If unspecified, the project will be created in the specified path or the current working directory.
  • -p, --path <projectPath> The path to create the new Unity project. If unspecified, the current working directory will be used.
  • -t, --template <projectTemplate> The name of the template package to use for creating the unity project. Supports regex patterns. (default: com.unity.template.3d(-cross-platform)?)
  • -u, --unity-version <unityVersion> The Unity version to get (e.g. 2020.3.1f1, 2021.x, 2022.1.*, 6000). If unspecified, then --unity-editor must be specified.
  • -e, --unity-editor <unityEditor> The path to the Unity Editor executable. If unspecified, -u, --unity-version, or the UNITY_EDITOR_PATH environment variable must be set.
  • --verbose Enable verbose logging.
  • --json Prints the last line of output as JSON string.

Creates a new Unity project named "MyGame" using the latest version of Unity 6 and the 3D template:

unity-cli create-project --name "MyGame" --template com.unity.template.3d(-cross-platform)? --unity-version 6000
Open Unity Project

open-project [options]: Open a Unity project in the Unity Editor.

  • -p, --unity-project <unityProject> The path to a Unity project. If unspecified, the UNITY_PROJECT_PATH environment variable or the current working directory will be used.
  • -u, --unity-version <unityVersion> The Unity version to get (e.g. 2020.3.1f1, 2021.x, 2022.1.*, 6000). If specified, it will override the version read from the project.
  • -t, --build-target <buildTarget> The Unity build target to switch the project to (e.g. StandaloneWindows64, StandaloneOSX, iOS, Android, etc).
  • --verbose Enable verbose logging.

Opens a specific Unity project with the latest Unity 6 version and switches the active platform to Android:

unity-cli open-project --unity-project <path-to-project> --unity-version 6000 --build-target Android

[!TIP] If you run this command in the same directory as your Unity project, you can omit the --unity-project, --unity-version, and --unity-editor options.

unity-cli open-project
Run Unity Editor Commands

run [options] <args...>: Run Unity Editor command line arguments (passes args directly to the editor).

  • --unity-editor <unityEditor> The path to the Unity Editor executable. If unspecified, --unity-project or the UNITY_EDITOR_PATH environment variable must be set.
  • --unity-project <unityProject> The path to a Unity project. If unspecified, the UNITY_PROJECT_PATH environment variable will be used, otherwise no project will be specified.
  • --log-name <logName> The name of the log file.
  • --verbose Enable verbose logging.
  • <args...> Arguments to pass directly to the Unity Editor executable.
unity-cli run --unity-project <path-to-project> -quit -batchmode -executeMethod StartCommandLineBuild

Unity Package Manager

Sign a Unity Package

[!WARNING] This command feature is in beta and may change in future releases.

sign-package [options]: Sign a Unity package for distribution.

  • --package <package> Required. The fully qualified path to the folder that contains the package.json file for the package you want to sign. Note: Don’t include package.json in this parameter value.
  • --output <output> Optional. The output directory where you want to save the signed tarball file (.tgz). If unspecified, the package contents will be updated in place with the signed .attestation.p7m file.
  • --email <email> Email associated with the Unity account. If unspecified, the UNITY_USERNAME environment variable will be used.
  • --password <password> The password of the Unity account. If unspecified, the UNITY_PASSWORD environment variable will be used.
  • --organization <organization> The Organization ID you copied from the Unity Cloud Dashboard. If unspecified, the UNITY_ORGANIZATION_ID environment variable will be used.
  • --verbose Enable verbose logging.

[!NOTE] The --output option is optional. If not specified, the package contents will be updated in place with the signed .attestation.p7m file. Otherwise a signed .tgz file will be created in the specified output directory.

unity-cli sign-package --package <path-to-package-folder> --email <your-email> --password <your-password> --organization <your-organization-id>