Package consumption workflow
Between nuget.org and private package galleries that your organization might establish, you can find tens of thousands of highly useful packages to use in your apps and services. But regardless of the source, consuming a package follows the same general workflow as shown below. For details, see Finding and Choosing Packages and Different ways to install a NuGet package.
* Except with
nuget install from the command-line, in which case it's necessary to edit the configuration files by hand. See the install command reference.
NuGet remembers the identity and version number of each installed package, recording it in either
packages.config or the project file, depending on project type and your version of NuGet. With NuGet 4.0+, storing dependencies in the project file, or PackageReference is generally the default, although this is configurable in Visual Studio through the Package Manager UI options. In any case, you can look in the appropriate file at any time to see the full list of dependencies for your project.
It's prudent to always check the license for each package you intend to use in your software. On nuget.org, you find a License Info link on the right side of each package's description page. If a package does not specify license terms, contact the package owner directly using the Contact owners link on the package page. Microsoft does not license any intellectual property to you from third party package providers and is not responsible for information provided by third parties.
When installing packages, NuGet typically checks if the package is already available from its cache. You can manually clear this cache from the command line, as described on Managing the NuGet cache.
NuGet also makes sure that the target frameworks supported by the package are compatible with your project. If the package does not contain compatible assemblies, NuGet will give you an error message. See Resolving incompatible package errors.
When adding project code to a source repository, you typically don't include NuGet packages. Those who later clone the repository, which includes build agents on systems like Visual Studio Team Services, must restore the necessary packages prior to running a build:
Package Restore uses the information in the project file or
packages.config to reinstall all dependencies. Note that there are differences in the process involved, as described in Dependency Resolution.
Occasionally it's necessary to reinstall packages that are already included in a project, which may also reinstall dependencies. This is easy to do using the
reinstall command via the NuGet command line or the NuGet Package Manager Console. For details, see Reinstalling and Updating Packages.
Finally, NuGet's behavior is driven by
Nuget.Config configuration files. Multiple files can be used to centralize certain settings at different levels, as explained in Configuring NuGet Behavior.
Enjoy your productive coding with NuGet packages!