From 99c297d597abf8ab91fd4175c1d5059ee8c730c9 Mon Sep 17 00:00:00 2001 From: Stephen Hodgson Date: Thu, 8 Oct 2026 11:28:26 -0400 Subject: [PATCH 01/10] Mark the package as maintenance mode ahead of the January 2027 archive. --- README.md | 20 +++++++++++++++++++- package.json | 2 +- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fc0a0ab..12af174 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,24 @@ [![Discord](https://img.shields.io/discord/855294214065487932.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/xQgMW9ufN4) [![NPM Version](https://img.shields.io/npm/v/%40rage-against-the-pixel%2Funity-cli)](https://www.npmjs.com/package/@rage-against-the-pixel/unity-cli) [![NPM Downloads](https://img.shields.io/npm/dw/%40rage-against-the-pixel%2Funity-cli)](https://www.npmjs.com/package/@rage-against-the-pixel/unity-cli) -A powerful all-in-one command line utility for the Unity Game Engine. Automate Unity project setup, editor installation, license management, building, upm package signing and more! Built specifially for CI/CD pipelines and developer workflows. +A CI wrapper for Unity Hub, licenses, editor runs, and UPM pack/sign. This package is in maintenance mode. + +## Maintenance + +Bug and security fixes only, and no new commands, through **January 1, 2027**, when this GitHub repository will be archived. After that date the repository is read-only: no new issues, pull requests, or fixes. `@rage-against-the-pixel/unity-cli` stays on npm and stays installable. + +Unity ships an official CLI named `unity`. As of October 8, 2026 it is still experimental (`1.0.0-beta.13`). There is no stable channel yet: the stable manifest returns 404 and only the beta manifest is published. See [Use the Unity CLI](https://docs.unity.com/en-us/unity-cli/use-unity-cli). Install it with `install.ps1` / `install.sh`, or with winget package `Unity.CLI`. The winget version `1.0.0.20013` is that same beta; `unity --version` reports `1.0.0-beta.13`. + +Prefer the official CLI for Hub install, editor install and uninstall, modules, project create and open, templates, run, build, test, serial and floating licenses, and headless service-account auth. + +Stay on this package when you still need: + +- UPM pack and sign (`upm-install`, `upm-pack`) +- Unity 4.x, 5.x, 2017, and 2018 installs +- Personal license activation with `--email` and `--password` +- Live Unity Test Protocol output turned into GitHub Actions annotations and log groups + +Until January 1, 2027, bug and security issues and pull requests are still in scope. Send feature requests that the official CLI already covers to Unity. > [!IMPORTANT] > The documented commands can download, install, or run software from Unity (Hub, Editor, Package Manager CLI, licensing tools, and similar binaries from Unity CDNs or services). That use is covered by Unity’s [Terms of Service](https://unity.com/legal/terms-of-service), the [Unity Editor Software Additional Terms](https://unity.com/legal/terms-of-service/software), and any other [Additional Terms](https://unity.com/legal/additional-terms) that apply to the offerings you use. Keep your Unity account, seats, and subscriptions in order, and read the agreements that actually bind you before relying on automation in CI or production. The full legal index is at [Unity Legal](https://unity.com/legal). @@ -11,6 +28,7 @@ A powerful all-in-one command line utility for the Unity Game Engine. Automate U ## Table of Contents +- [Maintenance](#maintenance) - [Features](#features) - [Unity version support](docs/unity-version-support.md) - [Installation](#installation) diff --git a/package.json b/package.json index 127cc1c..adff672 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@rage-against-the-pixel/unity-cli", "version": "3.0.2", - "description": "A command line utility for the Unity Game Engine.", + "description": "Maintenance mode. GitHub repo archives January 1, 2027. New projects should use Unity's official unity CLI.", "author": "RageAgainstThePixel", "license": "MIT", "repository": { From 6d60bfbb9c130e1d16d82e0458620490206e07a8 Mon Sep 17 00:00:00 2001 From: Stephen Hodgson Date: Thu, 8 Oct 2026 11:31:58 -0400 Subject: [PATCH 02/10] Restore the original npm package description. --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index adff672..127cc1c 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@rage-against-the-pixel/unity-cli", "version": "3.0.2", - "description": "Maintenance mode. GitHub repo archives January 1, 2027. New projects should use Unity's official unity CLI.", + "description": "A command line utility for the Unity Game Engine.", "author": "RageAgainstThePixel", "license": "MIT", "repository": { From aa1b23842316b100381cf15a4d1f120e34cc6c98 Mon Sep 17 00:00:00 2001 From: Stephen Hodgson Date: Thu, 8 Oct 2026 11:32:35 -0400 Subject: [PATCH 03/10] Drop the official CLI beta status from the maintenance note. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 12af174..6999fb6 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ A CI wrapper for Unity Hub, licenses, editor runs, and UPM pack/sign. This packa Bug and security fixes only, and no new commands, through **January 1, 2027**, when this GitHub repository will be archived. After that date the repository is read-only: no new issues, pull requests, or fixes. `@rage-against-the-pixel/unity-cli` stays on npm and stays installable. -Unity ships an official CLI named `unity`. As of October 8, 2026 it is still experimental (`1.0.0-beta.13`). There is no stable channel yet: the stable manifest returns 404 and only the beta manifest is published. See [Use the Unity CLI](https://docs.unity.com/en-us/unity-cli/use-unity-cli). Install it with `install.ps1` / `install.sh`, or with winget package `Unity.CLI`. The winget version `1.0.0.20013` is that same beta; `unity --version` reports `1.0.0-beta.13`. +Unity ships an official CLI named `unity`. See [Use the Unity CLI](https://docs.unity.com/en-us/unity-cli/use-unity-cli). Install it with `install.ps1` / `install.sh`, or with winget package `Unity.CLI`. Prefer the official CLI for Hub install, editor install and uninstall, modules, project create and open, templates, run, build, test, serial and floating licenses, and headless service-account auth. From 00ef01117fd890d1b4f94d3ee7f56a40b800ee59 Mon Sep 17 00:00:00 2001 From: Stephen Hodgson Date: Thu, 8 Oct 2026 11:34:01 -0400 Subject: [PATCH 04/10] Point UPM pack and sign at Unity's official upm CLI. --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6999fb6..ec8cc97 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Discord](https://img.shields.io/discord/855294214065487932.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/xQgMW9ufN4) [![NPM Version](https://img.shields.io/npm/v/%40rage-against-the-pixel%2Funity-cli)](https://www.npmjs.com/package/@rage-against-the-pixel/unity-cli) [![NPM Downloads](https://img.shields.io/npm/dw/%40rage-against-the-pixel%2Funity-cli)](https://www.npmjs.com/package/@rage-against-the-pixel/unity-cli) -A CI wrapper for Unity Hub, licenses, editor runs, and UPM pack/sign. This package is in maintenance mode. +A CI wrapper for Unity Hub, licenses, and editor runs. This package is in maintenance mode. ## Maintenance @@ -12,9 +12,10 @@ Unity ships an official CLI named `unity`. See [Use the Unity CLI](https://docs. Prefer the official CLI for Hub install, editor install and uninstall, modules, project create and open, templates, run, build, test, serial and floating licenses, and headless service-account auth. +Pack and sign UPM packages with Unity's [Unity Package Manager CLI](https://docs.unity3d.com/Manual/upm-cli.html) (`upm`). Install it from [Install Unity Package Manager CLI](https://docs.unity3d.com/Manual/upm-cli-install.html), then use [`upm pack`](https://docs.unity3d.com/Manual/upm-cli-pack.html). + Stay on this package when you still need: -- UPM pack and sign (`upm-install`, `upm-pack`) - Unity 4.x, 5.x, 2017, and 2018 installs - Personal license activation with `--email` and `--password` - Live Unity Test Protocol output turned into GitHub Actions annotations and log groups @@ -382,6 +383,8 @@ unity-cli editor-logs ### Unity Package Manager +Unity publishes the pack and sign tool as its own CLI. See [Unity Package Manager CLI workflow](https://docs.unity3d.com/Manual/upm-cli.html). The commands below call that same `upm` binary. + #### Install Unity Package Manager `upm-install [options]`: Download and install the Unity Package Manager cli (pack/sign). From 6fbde56b32ffddf8ea324c0cc936b4d6d835563d Mon Sep 17 00:00:00 2001 From: Stephen Hodgson Date: Thu, 8 Oct 2026 11:35:20 -0400 Subject: [PATCH 05/10] Put official Unity and UPM install commands in code blocks. --- README.md | 38 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 36 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ec8cc97..c48b31a 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,45 @@ A CI wrapper for Unity Hub, licenses, and editor runs. This package is in mainte Bug and security fixes only, and no new commands, through **January 1, 2027**, when this GitHub repository will be archived. After that date the repository is read-only: no new issues, pull requests, or fixes. `@rage-against-the-pixel/unity-cli` stays on npm and stays installable. -Unity ships an official CLI named `unity`. See [Use the Unity CLI](https://docs.unity.com/en-us/unity-cli/use-unity-cli). Install it with `install.ps1` / `install.sh`, or with winget package `Unity.CLI`. +Unity ships an official CLI named `unity`. See [Use the Unity CLI](https://docs.unity.com/en-us/unity-cli/use-unity-cli). + +macOS or Linux: + +```bash +curl -fsSL https://unity.com/install.sh | bash +``` + +Windows (PowerShell): + +```powershell +irm https://unity.com/install.ps1 | iex +``` + +Windows (winget): + +```powershell +winget install Unity.CLI +``` Prefer the official CLI for Hub install, editor install and uninstall, modules, project create and open, templates, run, build, test, serial and floating licenses, and headless service-account auth. -Pack and sign UPM packages with Unity's [Unity Package Manager CLI](https://docs.unity3d.com/Manual/upm-cli.html) (`upm`). Install it from [Install Unity Package Manager CLI](https://docs.unity3d.com/Manual/upm-cli-install.html), then use [`upm pack`](https://docs.unity3d.com/Manual/upm-cli-pack.html). +Pack and sign UPM packages with Unity's [Unity Package Manager CLI](https://docs.unity3d.com/Manual/upm-cli.html) (`upm`). See [Install Unity Package Manager CLI](https://docs.unity3d.com/Manual/upm-cli-install.html) and [`upm pack`](https://docs.unity3d.com/Manual/upm-cli-pack.html). + +macOS or Linux: + +```bash +curl -fsSL https://cdn.packages.unity.com/upm-cli/install.sh | bash +``` + +Windows (PowerShell): + +```powershell +irm https://cdn.packages.unity.com/upm-cli/install.ps1 | iex +``` + +```bash +upm pack --organization-id --destination +``` Stay on this package when you still need: From 02e515026c7cfbc65b7abeedbeec9fb8045ea48d Mon Sep 17 00:00:00 2001 From: Stephen Hodgson Date: Thu, 8 Oct 2026 11:38:50 -0400 Subject: [PATCH 06/10] Use winget on Windows and bash everywhere else. --- README.md | 21 ++------------------- 1 file changed, 2 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index c48b31a..d33d7f8 100644 --- a/README.md +++ b/README.md @@ -16,15 +16,9 @@ macOS or Linux: curl -fsSL https://unity.com/install.sh | bash ``` -Windows (PowerShell): +Windows: -```powershell -irm https://unity.com/install.ps1 | iex -``` - -Windows (winget): - -```powershell +```bash winget install Unity.CLI ``` @@ -32,19 +26,8 @@ Prefer the official CLI for Hub install, editor install and uninstall, modules, Pack and sign UPM packages with Unity's [Unity Package Manager CLI](https://docs.unity3d.com/Manual/upm-cli.html) (`upm`). See [Install Unity Package Manager CLI](https://docs.unity3d.com/Manual/upm-cli-install.html) and [`upm pack`](https://docs.unity3d.com/Manual/upm-cli-pack.html). -macOS or Linux: - ```bash curl -fsSL https://cdn.packages.unity.com/upm-cli/install.sh | bash -``` - -Windows (PowerShell): - -```powershell -irm https://cdn.packages.unity.com/upm-cli/install.ps1 | iex -``` - -```bash upm pack --organization-id --destination ``` From abbd3120b348e680e2d1c4a547203c3b4d1620da Mon Sep 17 00:00:00 2001 From: Stephen Hodgson Date: Thu, 8 Oct 2026 11:39:58 -0400 Subject: [PATCH 07/10] Split the UPM install and pack commands into separate code blocks. --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index d33d7f8..8dd1722 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,9 @@ Pack and sign UPM packages with Unity's [Unity Package Manager CLI](https://docs ```bash curl -fsSL https://cdn.packages.unity.com/upm-cli/install.sh | bash +``` + +```bash upm pack --organization-id --destination ``` From 97f71f42410dd4e60af625875e311e0fab78f795 Mon Sep 17 00:00:00 2001 From: Stephen Hodgson Date: Thu, 8 Oct 2026 11:40:46 -0400 Subject: [PATCH 08/10] Link to the official Unity CLI and UPM docs instead of copying install steps. --- README.md | 26 ++------------------------ 1 file changed, 2 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 8dd1722..a2dcb23 100644 --- a/README.md +++ b/README.md @@ -8,31 +8,9 @@ A CI wrapper for Unity Hub, licenses, and editor runs. This package is in mainte Bug and security fixes only, and no new commands, through **January 1, 2027**, when this GitHub repository will be archived. After that date the repository is read-only: no new issues, pull requests, or fixes. `@rage-against-the-pixel/unity-cli` stays on npm and stays installable. -Unity ships an official CLI named `unity`. See [Use the Unity CLI](https://docs.unity.com/en-us/unity-cli/use-unity-cli). +Unity ships an official CLI named `unity`. See [Use the Unity CLI](https://docs.unity.com/en-us/unity-cli/use-unity-cli). Prefer it for Hub install, editor install and uninstall, modules, project create and open, templates, run, build, test, serial and floating licenses, and headless service-account auth. -macOS or Linux: - -```bash -curl -fsSL https://unity.com/install.sh | bash -``` - -Windows: - -```bash -winget install Unity.CLI -``` - -Prefer the official CLI for Hub install, editor install and uninstall, modules, project create and open, templates, run, build, test, serial and floating licenses, and headless service-account auth. - -Pack and sign UPM packages with Unity's [Unity Package Manager CLI](https://docs.unity3d.com/Manual/upm-cli.html) (`upm`). See [Install Unity Package Manager CLI](https://docs.unity3d.com/Manual/upm-cli-install.html) and [`upm pack`](https://docs.unity3d.com/Manual/upm-cli-pack.html). - -```bash -curl -fsSL https://cdn.packages.unity.com/upm-cli/install.sh | bash -``` - -```bash -upm pack --organization-id --destination -``` +Pack and sign UPM packages with Unity's [Unity Package Manager CLI](https://docs.unity3d.com/Manual/upm-cli.html). See [Install Unity Package Manager CLI](https://docs.unity3d.com/Manual/upm-cli-install.html) and [Pack and sign a package with Unity Package Manager CLI](https://docs.unity3d.com/Manual/upm-cli-pack.html). Stay on this package when you still need: From 212e5ef8f0f63ea0f87768bd0b554d501aeb21a7 Mon Sep 17 00:00:00 2001 From: Stephen Hodgson Date: Thu, 8 Oct 2026 11:44:10 -0400 Subject: [PATCH 09/10] Open the maintenance note with the author's statement. --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a2dcb23..2bba6dd 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,15 @@ [![Discord](https://img.shields.io/discord/855294214065487932.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/xQgMW9ufN4) [![NPM Version](https://img.shields.io/npm/v/%40rage-against-the-pixel%2Funity-cli)](https://www.npmjs.com/package/@rage-against-the-pixel/unity-cli) [![NPM Downloads](https://img.shields.io/npm/dw/%40rage-against-the-pixel%2Funity-cli)](https://www.npmjs.com/package/@rage-against-the-pixel/unity-cli) -A CI wrapper for Unity Hub, licenses, and editor runs. This package is in maintenance mode. +> [!WARNING] +> This package is in maintenance mode. + +A powerful all-in-one command line utility for the Unity Game Engine. Automate Unity project setup, editor installation, license management, building, upm package signing and more! Built specifially for CI/CD pipelines and developer workflows. ## Maintenance +In unity's infinite wisdom, they decided to rip off another one of my open source projects with a clone of their own. which has blessed me with more free time and ability to work on other projects. As always, I build these kinds of tools because there is a gap in tooling or some need of mine to fulfil. I only wish that one day I get credit for the hard work I've been doing over the last 20 years to bring game and joy to people's lives. + Bug and security fixes only, and no new commands, through **January 1, 2027**, when this GitHub repository will be archived. After that date the repository is read-only: no new issues, pull requests, or fixes. `@rage-against-the-pixel/unity-cli` stays on npm and stays installable. Unity ships an official CLI named `unity`. See [Use the Unity CLI](https://docs.unity.com/en-us/unity-cli/use-unity-cli). Prefer it for Hub install, editor install and uninstall, modules, project create and open, templates, run, build, test, serial and floating licenses, and headless service-account auth. From 3440db42a0a01265b70ceb3be20e4ef8da141762 Mon Sep 17 00:00:00 2001 From: Stephen Hodgson Date: Thu, 8 Oct 2026 11:46:36 -0400 Subject: [PATCH 10/10] Apply the author's wording fixes in the maintenance note. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2bba6dd..f3e70cf 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ A powerful all-in-one command line utility for the Unity Game Engine. Automate U ## Maintenance -In unity's infinite wisdom, they decided to rip off another one of my open source projects with a clone of their own. which has blessed me with more free time and ability to work on other projects. As always, I build these kinds of tools because there is a gap in tooling or some need of mine to fulfil. I only wish that one day I get credit for the hard work I've been doing over the last 20 years to bring game and joy to people's lives. +In unity's infinite wisdom, they decided to rip off yet another one of my open source projects with a clone of their own. which has blessed me with more free time and ability to work on other projects. As always, I build these kinds of tools because there is a gap in tooling or some need of mine to fulfil. I only wish that one day I get credit for the hard work I've been doing over the last 20 years to bring games and joy to people's lives. Bug and security fixes only, and no new commands, through **January 1, 2027**, when this GitHub repository will be archived. After that date the repository is read-only: no new issues, pull requests, or fixes. `@rage-against-the-pixel/unity-cli` stays on npm and stays installable.