Installing from a Git URL

The Package Manager can load a package from a Git repository on a remote server.

For more information about using Git dependenciesIn the context of the Package Manager, a dependency is a specific package version (expressed in the form package_name@package_version) that a project or another package requires in order to work. Projects and packages use the dependencies attribute in their manifests to define the set of packages they require. For projects, these are considered direct dependencies; for packages, these are indirect, or transitive, dependencies. More info
See in Glossary with the Unity Package Manager, see the documentation on using Git URLs in your project manifestEach Unity project has a project manifest, which acts as an entry point for the Package Manager. This file must be available in the <project>/Packages directory. The Package Manager uses it to configure many things, including a list of dependencies for that project, as well as any package repository to query for packages. More info
See in Glossary.

To load a package from a Git URL:

1. Click the add button in the status bar.

2. The options for adding packages appear.

   

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.

   

   Unity supports several Git protocols and some custom or extended syntax. For more information about how to construct a valid Git URL, see Git URLs and extended syntax.

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:

• No ‘git’ executable was found
• git-lfs: command not found
• Repository not found
• Could not 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 update your Git dependencyThe 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 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.