Skip to content

RageAgainstThePixel/unity-cli

Repository files navigation

unity-cli

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.

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

unity-cli [command] [options]

Common Commands

  • unity-cli hub-install: Install Unity Hub
  • unity-cli hub-version: Print Unity Hub version
  • unity-cli hub-path: Print Unity Hub executable path
  • unity-cli hub [args...]: Run Unity Hub commands directly
  • unity-cli activate-license: Activate a Unity license
  • unity-cli return-license: Return a Unity license
  • unity-cli license-version: Print Unity License Client version
  • unity-cli setup-unity: Find or install Unity Editor for a project/version
  • unity-cli create-project: Create a new Unity project from a template
  • unity-cli run [args...]: Run commands in Unity Editor Command Line Arguments

Install Unity Hub and Editor

unity-cli hub-install
unity-cli setup-unity --unity-version 2022.3.x --modules android,ios --json

Activate a Unity License

unity-cli activate-license --email <your-email> --password <your-password> --serial <your-serial>

Create a New Project from a Template

unity-cli create-project --name "MyGame" --template com.unity.template.3d --unity-editor <path-to-editor>

Build a Project

unity-cli run --unity-editor <path-to-editor> --unity-project <path-to-project> -quit -batchmode -executeMethod Utilities.Editor.BuildPipeline.UnityPlayerBuildTools.StartCommandLineBuild

About

A command line utility for the Unity Game Engine

Resources

License

Stars

Watchers

Forks

Sponsor this project

  •  

Packages

No packages published