Sitecore How-To: Add Sitecore NuGet Packages to Your Project

• Overview
• How-To
• Step-by-step guide

Overview

This is an article in a series of Sitecore how-to articles. These articles are meant to be quick guides to accomplish various tasks within Sitecore. The how-to articles have proven to be very helpful internally at One North Interactive https://www.onenorth.com. These articles assume working Sitecore knowledge. I just wanted to share the articles with the community. Hopefully you find them helpful.

How-To

When you want to reference Sitecore binaries in your Visual Studio project, use Sitecore’s NuGet Feed.

Starting with Sitecore 9.1, Sitecore changed their NuGet package strategy so the version name is major.minor.update (instead of major.minor.rev) and they no longer create the NoReferences package variations. If you only want to reference the package and not add its dependencies, make sure to specify the Ignore Dependencies option.

Step-by-step guide

1. Make sure you add Sitecore’s NuGet Feed to Visual Studio: Sitecore How-To: Add Sitecore’s NuGet Repository To Visual Studio
2. Using the NuGet UI within Visual Studio:
   1. Browse for the package you want to add (Sitecore.Kernel) and make sure Package source (drop down in top right corner) is either All or Sitecore NuGet (the source you added in step 1).
   2. See the above note about NoReferences packages and the Ignore Dependencies option.
   3. Select the Sitecore version you are working with and install.
3. Using the NuGet Package Manager Console:

   Install-Package -ProjectName Website -IgnoreDependencies -ID Sitecore.Kernel -Version 9.1.1
   

   or, if you want all dependencies

   Install-Package -ProjectName Website -ID Sitecore.Kernel -Version 9.1.1
   

Installing dependencies of a Sitecore package will install many packages and is most likely not desired. The only exception is for your main Website project, where you may want it to install the correct packages for MVC, Lucene, etc.