Skip to content

Latest commit

 

History

History
77 lines (46 loc) · 3.01 KB

cmd-add.md

File metadata and controls

77 lines (46 loc) · 3.01 KB
Raw

openupm add

The add command adds one or more dependencies to a Unity project. This means that it adds the given packages to the projects direct dependencies as well as configuring scoped registries so that Unity can resolve the dependencies.

Currently openupm does not install the dependencies into the project itself. This is left for Unity to do.

You should run this command inside the projects root directory.

This command has the following aliases: install and i. On this doc page we will always use the primary command name add.

Arguments

Packages

Specify one or more packages for openupm to add. The general format for a package reference is name@version.

openupm add com.my.package@1.0.0

The version may be a specific version, a predefined tag or a url version1. For more information about how the version can be specified checkout the corresponding help page.

Options

Testables

If you also want to add packages to the projects testables run the command with the --test option.

openupm add com.my.package --test

Force

By default openupm validates added packages to check whether they can be added to the project 1. Specifically openupm will check whether all indirect dependencies can be resolved and whether the package is compatible with the projects editor version. If validation fails then the package can not be added.

If you know what you doing and want to add the package even though there are validation problems you can run with the --force/-f option to bypass validation.

openupm add com.my.package --force

Registry

By default openupm resolves packages from the openupm and Unity registries in that order. This behavior is configurable, specifically if you want to work with 3rd party registries.

You can override the primary registry from which to resolve packages using the --registry option.

openupm add com.my.package --registry https://packages.my.registry

You can also use the --no-upstream option if you don't want to resolve from the Unity registry.

openupm add com.my.package --no-upstream

For more information read the help article about working with 3rd party registries.

Project directory

By default openupm expects that you run the add command inside your Unity projects root directory. Based on this it determines relative paths to your package manifest etc.

If you need to run openupm from somewhere else you can change the working directory using the --chdir/-c option. This option accepts an absolute path to a Unity projects root directory.

openupm add com.my.package -c /home/user/dev/MyProject

Windows system-user authentication

This command supports Windows system-user authentication. For more information check out the corresponding article.

Footnotes

  1. openupm does not validate or resolve indirect dependencies for url-based dependencies. ↩ ↩2