Manual: Install a UPM package from a Git URL (original) (raw)

Install a UPM package from a local tarball file

Install a UPM package by name

The Package Manager can load a UPM packageA Package managed by the Unity Package Manager. Refer to Packages.
See in Glossary from a Git repository on a remote server.

Prerequisites

• Install the Git client (minimum version 2.14.0) on your computer.
• On Windows, add the Git executable path to the PATH system environment variable.
• If the target repository tracks files with Git LFS, install the Git LFS client on your computer.
• Read the information about using Git dependenciesThe Package Manager retrieves Git dependencies from a Git repository directly rather than from a package registry. Git dependencies use a Git URL reference instead of a version, and there’s no guarantee about the package quality, stability, validity, or even whether the version stated in its package.json file respects Semantic Versioning rules with regards to officially published releases of this package. More info
  See in Glossary in your project.

Procedure

To install a UPM package from a Git URL:

1. Open the Package Manager window, if it’s not already open.
2. Open the Add (+) menu in the Package Manager’s toolbar.
3. The options for installing packages appear.
   
   Install package from git URL button
4. Select Install package from git URL from the install menu. A text box and an Install button appear.
5. Enter a valid Git URL in the text box. For information about how to construct a valid Git URL, refer to Git URLs and extended syntax. Examples of valid Git URLs include:
   • https://github.example.com/myuser/myrepo.git (if your package is in the root of the repository).
   • https://github.example.com/myuser/myrepo.git?path=/subfolder (if your package is in a subfolder within the repository).
6. Select Install.

If Unity was able to install the package successfully, the package now appears in the package list with the git label. If Unity wasn’t able to install the package, the Unity Console displays an error message, such as:

• No ‘Git’ executable was found
• Git-lfs: command not found
• Repository not found
• Couldn’t read Username: terminal prompts disabled

Click on an error message link to get some help for it on the Troubleshooting page.

Tip: If you want to check for updates and update your Git dependency to the latest version from the repository, click Update. You can also use the Install package from git URL menu item to update your Git dependency. For information on Git dependencies, refer to Locked Git dependencies.

Additional resources

• Package types
• Add and remove UPM packages or feature sets
• Add and remove asset packages

Install a UPM package from a local tarball file

Install a UPM package by name