openupm-cli

openupm-cli

The command-line tool to maintain the Unity manifest file for 3rd-party upm registries, offering a similar but lighter experience like npm or yarn for Node.js.

The tool is designed to work with the OpenUPM registry, but can also work with any upm registries, including the official Unity registry.

• openupm-cli
  • How it works
  • Installation
    • Windows platform troubleshooting
    • Cannot find module 'node:net'
  • Commands
    • Add packages
    • Remove packages
    • Search packages
    • View package information
    • View package dependencies
    • Global command options
  • General help pages
  • Contributors

How it works

The command-line tool installs the 3rd-party registry as a scoped registry and maintains the Packages/manifest.json file when adding/removing packages. If the manifest file is modified, the Unity Package Manager will detect the changes and try to resolve the package dependencies.

Notice: the command-line tool does not directly install/uninstall package tarballs, at least for now.

Installation

• Requires nodejs 18 or above.

• Install via npm:

  npm install -g openupm-cli
  

• Or install via yarn:

  yarn global add openupm-cli
  

Windows platform troubleshooting

If npm is not available in your CMD/PowerShell/Git-Bash, please configure your environment variables.

# for npm
c:\Program Files\nodejs

# for npm global bin
C:\Users\{yourName}\AppData\Roaming\npm

Cannot find module 'node:net'

internal/modules/cjs/loader.js:818
  throw err;
  ^

Error: Cannot find module 'node:net'

Please install Node.js 18 or above.

Commands

Add packages

Use openupm add to add one or more dependencies to your project.

openupm add com.my.package@1.2.3

Checkout the commands doc page for more information.

Remove packages

Use openupm remove to remove one or more dependencies from your project.

openupm remove com.my.package

Checkout the commands doc page for more information.

Search packages

Use openupm search to search for remote packages by name.

openupm search something

Checkout the commands doc page for more information.

View package information

Use openupm view to view detailed information about a remote package.

openupm view com.my.package

Checkout the commands doc page for more information.

View package dependencies

Use openupm deps to print package dependencies.

openupm deps com.my.package

Checkout the commands doc page for more information.

List installed packages

Use openupm ls to print the names and versions of installed packages.

openupm ls

Checkout the commands doc page for more information.

Global command options

There are also some global options that work for every command. You can read about them here.

General help pages

We also have a few guide pages on specific topics if you need help:

• Working with 3rd party registries
• Using Windows system-user authentication

Contributors

Favo Yang 💻 🚧	Ramon Brullo 💻 🚧	Koji Hasegawa 💻 🐛	MonoLogueChi 🐛	Masahiro Yamaguchi 🐛	Max Himmel 🐛	Wilfredo Velázquez-Rodríguez 🐛
Christopher Arendt 🐛	Felix Winterhalter 🐛	Antoine Lelievre 🐛	Tyler Temp 🐛	Marc Bernard 📖