Version: 2021.3
Language : English
Install a package from a local tarball file
Install a package from a registry by name

Install a package from a Git URL

The Package Manager can load a package 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 load a package from a Git URL:

  1. Open the add menu in the Package Manager’s toolbar.

  2. The options for adding packages appear.

    Add package from git URL button
    Add package from git URL button
  3. Select Add package from git URL from the add menu. A text box and an Add button appear.

  4. Enter a valid Git URL in the text box and click Add. For more information about how to construct a valid Git URL, see Git URLs and extended syntax. Unity supports several Git protocols and some custom or extended syntax.

    Enter the Git URL and click Add
    Enter the Git URL and click Add

If Unity was able to install the package successfully, the package now appears in the package list with the tag. If Unity was not able to install the package, the Unity Console displays an error message, such as:

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

Tip: If you want to update your Git dependency to a newer version from the repository, use the Add package from git URL button to enter a Git URL. For more information, see Locked Git dependencies.


Install a package from a local tarball file
Install a package from a registry by name