Skip to content

Mark unity-cli as maintenance mode #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
StephenHodgson merged 10 commits into from
Oct 8, 2026
Merged

Mark unity-cli as maintenance mode #85

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
99c297d
Mark the package as maintenance mode ahead of the January 2027 archive.
StephenHodgson Oct 8, 2026
6d60bfb
Restore the original npm package description.
StephenHodgson Oct 8, 2026
aa1b238
Drop the official CLI beta status from the maintenance note.
StephenHodgson Oct 8, 2026
00ef011
Point UPM pack and sign at Unity's official upm CLI.
StephenHodgson Oct 8, 2026
6fbde56
Put official Unity and UPM install commands in code blocks.
StephenHodgson Oct 8, 2026
02e5150
Use winget on Windows and bash everywhere else.
StephenHodgson Oct 8, 2026
abbd312
Split the UPM install and pack commands into separate code blocks.
StephenHodgson Oct 8, 2026
97f71f4
Link to the official Unity CLI and UPM docs instead of copying instal…
StephenHodgson Oct 8, 2026
212e5ef
Open the maintenance note with the author's statement.
StephenHodgson Oct 8, 2026
3440db4
Apply the author's wording fixes in the maintenance note.
StephenHodgson Oct 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,37 @@

[![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)

> [!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 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.

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.

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:

- 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).
>
> Unity, Unity Hub, Unity Editor, and related names and logos are trademarks and other intellectual property of Unity Technologies Inc. and its affiliates. This project is independent and not affiliated with Unity. Names are used here only to describe what the commands talk to. If you ship Unity marks, artwork, or binaries, use Unity’s guidance, including their [IP policy](https://unity.com/legal/ip-policy-takedown-requests).

## Table of Contents

- [Maintenance](#maintenance)
- [Features](#features)
- [Unity version support](docs/unity-version-support.md)
- [Installation](#installation)
Expand Down Expand Up @@ -364,6 +386,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).
Expand Down