Finding and evaluating NuGet packages for your project
When starting any .NET project, or whenever you identify a functional need for your app or service, you can save yourself lots of time and trouble by using existing NuGet packages that fulfill that need. These packages can come from the public collection on nuget.org, or a private source that's provided by your organization or another third party.
When you visit nuget.org or open the Package Manager UI in Visual Studio, you see a list of packages sorted by total downloads. This immediately shows you the most widely-used packages across the millions of .NET projects. There's a good chance, then, that at least some of the packages listed on the first few pages will be useful in your projects.
Notice the Include prerelease option on the upper right of the page. When selected, nuget.org shows all versions of packages including beta and other early releases. To show only stable released, clear the option.
For specific needs, searching by tags (within the Visual Studio Package Manager or on a portal like nuget.org) is the most common means of discovering a suitable package. For example, searching on "json" lists all NuGet packages that are tagged with that keyword and thus have some relationship to the JSON data format.
You can also search using the package ID, if you know it. See Search Syntax below.
At this time, search results are sorted only by relevance, so you generally want to look through at least the first few pages of results for packages that suit your needs, or refine your search terms to be more specific.
Does the package support my project's target framework?
NuGet installs a package into a project only if that package's supported frameworks include the project's target framework. If the package is not compatible, NuGet issues an error.
Some packages list their supported frameworks directly in the nuget.org gallery, but because such data is not required, many packages do not include that list. At present there is no means to search nuget.org for packages that support a specific target framework (the feature is under consideration, see NuGet Issue 2936).
Fortunately, you can determine supported frameworks through two other means:
Attempt to install a package into a project using the
Install-Packagecommand in the NuGet Package Manager Console. If the package is incompatible, this command shows you the package's supported frameworks.
Download the package from its page on nuget.org using the Manual download link under Info. Change the extension from
.zip, and open the file to examine the content of its
libfolder. There you see subfolders for each of the supported frameworks, where each subfolder is named with a target framework moniker (TFM; see Target Frameworks). If you see no subfolders under
liband only a single DLL, then you must attempt to install the package in your project to discover its compatibility.
Many package authors make preview and beta releases available as they continue to make improvements and seek feedback on their latest revisions.
By default, nuget.org shows pre-release packages in search results. To search only stable releases, clear the Include prerelease option on the upper right of the page
In Visual Studio, and when using the NuGet and dotnet CLI tools, NuGet does not include pre-release versions by default. To change this behavior, do the following steps:
Package Manager UI in Visual Studio: In the Manage NuGet Packages UI, set the Include prerelease box. Setting or clearing this box refreshes the Package Manager UI and the list of available versions you can install.
Package Manager Console: Use the
-IncludePrereleaseswitch with the
Update-Packagecommands. Refer to the PowerShell Reference.
nuget.exe CLI: Use the
-prereleaseswitch with the
mirrorcommands. Refer to the NuGet CLI reference
dotnet.exe CLI: Specify the exact pre-release version using the
-vargument. Refer to the dotnet add package reference.
Native C++ packages
NuGet supports native C++ packages can that can be used in C++ projects in Visual Studio. This enables the Manage NuGet Packages context-menu command for projects, introduces a
native target framework, and provides MSBuild integration.
To find native packages on nuget.org, search using
tag:native. Such packages typically provide
.props files, which NuGet imports automatically when the package is added to a project.
The best way to evaluate the usefulness of a package is to download it and try it out in your code (all packages on nuget.org are routinely scanned for viruses, by the way). After all, every highly popular package got started with only a few developers using it, and you might be one of the early adopters!
At the same time, using a NuGet package means taking a dependency on it, so you want to make sure it's robust and reliable. Because installing and directly testing a package is time-consuming, you can also learn a lot about a package's quality by using the information on a package's listing page:
Downloads statistics: on the package page on nuget.org, the Statistics section shows total downloads, downloads of the most recent version, and average downloads per day. Larger numbers indicate that many other developers have taken a dependency on the package, which means that it has proven itself.
GitHub Usage: on the package page, the GitHub Usage section lists the top GitHub repositories that depend on this package. A package that many popular GitHub repositories depend on is typically a better choice.
Version history: on the package page, look under Info for the date of the most recent update and examine the Version History. A well-maintained package has recent updates and a rich version history. Neglected packages have few updates and often haven't been updated in some time.
Recent installs: on the package page under Statistics, select View full stats. The full stats page shows the package installs over the last six weeks by version number. A package that other developers are actively using is typically a better choice than one that's not.
Support: on the package page under Info, select Project Site (if available) to see what support options the author provides. A project with a dedicated site is generally better supported.
Developer history: on the package page under Owners, select an owner to see what other packages they've published. Those with multiple packages are more likely to continue supporting their work in the future.
Open source contributions: many packages are maintained in open-source repositories, making it possible for developers depending on them to directly contribute bug fixes and feature improvements. The contribution history of any given package is also a good indicator of how many developers are actively involved.
Interview the owners: new developers can certainly be equally committed to producing great packages for you to use, and it's good to give them a chance to bring something new to the NuGet ecosystem. With this in mind, reach out directly to the package developers through the Contact Owners option under Info on the listing page. Chances are, they'll be happy to work with you to serve your needs!
Reserved Package ID Prefixes: many package owners have applied for and have been granted a reserved package ID prefix. When you see the visual checkmark next to a package ID on nuget.org, or in Visual Studio, that means that the package owner has met our criteria for ID prefix reservation. This means the package owner is being clear on identifying themselves and their package.
Always be mindful of a package's license terms, which you can see by selecting License Info on a package's listing page on nuget.org. 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.
License URL deprecation
As we transition from licenseUrl to license, some NuGet clients and NuGet feeds may not yet have the ability to surface licensing information in some cases. To maintain backward compatibility, the license URL points to this document which talks about how to retrieve the license information in such cases.
If clicking on the license URL for a package brought you to this page, it implies the package contains a license file and
- You are connected to a feed that does not yet know how to interpret and surface the new license information to the client OR
- You are using a client that does not yet know how to interpret and read the new license information that is potentially provided by the feed OR
- A combination of both
Here is how you could read the information contained in the license file inside the package:
- Download the NuGet package, and unzip its contents to a folder.
- Open the
.nuspecfile which would be at the root of that folder.
- It should have a tag like
<license type="file">license\license.txt</license>. This implies the license file is named
license.txtand it is inside a folder called
licensewhich would also be at the root of that folder.
- Navigate to the
licensefolder and open the
For the MSBuild equivalent to setting the license in the
.nuspec, take a look at Packing a license expression or a license file.
NuGet package search works the same on nuget.org, from the NuGet CLI, and within the NuGet Package Manager extension in Visual Studio. In general, search is applied to keywords as well as package descriptions.
Keywords: Search looks for relevant packages that contain any of the provided keywords. Example:
modern UI. To search for packages that contain all of the provided keywords, use "+" between the terms, such as
Phrases: Entering terms within quotation marks looks for exact case-insensitive matches to those terms. Example:
"modern UI" package
Filtering: You can apply a search term to a specific property by using the syntax
<property>(case-insensitive) can be
owner. Terms can be contained in quotes if needed, and you can search for multiple properties at the same time. Also, searches on the
idproperty are substring matches, whereas
packageiduses an exact match. Examples:
id:NuGet.Core # Match any part of the id property Id:"Nuget.Core" ID:jQuery title:jquery # Searches title as shown on the package listing PackageId:jquery # Match the package id exactly id:jquery id:ui # Search for multiple terms in the id id:jquery tags:validation # Search multiple properties id:"jquery.ui" # Phrase search invalid:jquery ui # Unsupported properties are ignored, so this # is the same as searching on jquery ui