NuGet is a free, open source package management system for .NET and consists out of a few client tools (NuGet Command Line and NuGet Visual Studio Extension) and the official NuGet Gallery hosted at http://www.nuget.org/. Combined, these tools and the gallery form the NuGet project, governed by Outercurve Foundation and part of the ASP.NET Open Source Gallery. Although fully open source, Microsoft has extensively contributed to the development of the NuGet project.
First introduced in 2010, NuGet has been around for a few years now and many people and organizations are beginning to realize that NuGet presents a great opportunity to improve and automate parts of their development processes. Whether you work on open source projects or in an enterprise environment, NuGet is here to stay, but you have a way bigger NuGet ecosystem at your disposal today.
This article talks about the NuGet ecosystem. If you are new to NuGet or need practical guidance on how to use NuGet, then I highly recommend you to read through the NuGet documentation or buy the book Pro NuGet for a full reference, tips and tricks.
Using a new tool or technology usually comes with a learning curve. Luckily for you, NuGet has no steap learning curve it all! In fact, anyone can get started consuming packages in no time. Authoring packages however, and especially authoring good packages, as well as embracing NuGet in your automated build and deployment processes requires some research in order to get things right.
The following pointers should help you get the maximum out of NuGet:
The NuGet ecosystem
Because the NuGet project is open source under a permissive Apache v2 license, other projects can leverage NuGet and companies can build support for it in their products. All of them extend the NuGet ecosystem to what it is today, containing:
The sources for the Outercurve NuGet clients can be found on Codeplex, while the NuGet Gallery sources are available on GitHub.
The Outercurve tools for NuGet include:
NuGet Core project
License: Apache v2
Most NuGet client tools are based on the cross-platform
project. If you want to build your own NuGet client, you're best bet is to fetch the NuGet.Core project's sources from Codeplex
, or to run the following command in the NuGet Package Manager Console:
- NuGet Command Line tool (which is a wrapper around NuGet.Core)
- NuGet Server project
- NuGet Concierge
- Official NuGet Gallery at http://www.nuget.org
If you want to setup your own NuGet server using the tools provided by the Outercurve Foundation, you can do so using any of the following methods:
- To create a basic NuGet server and point it to a local folder or network share, create a new ASP.NET application and run the following command in the Package Manager Console:
- requires minimal infrastructure (IIS and some diskspace)
- requires .NET Framework 4.0
- non-indexed storage (slower as repository-size increases)
- single API key for entire server
- no fine-grained security
- single NuGet feed per NuGet.Server application
- To set up your own NuGet Gallery, fetch the sources from GitHub and follow the instructions at https://github.com/NuGet/NuGetGallery.
- indexed storage (faster querying)
- basic user system (authentication, API-key per user, manage own packages, emails)
- supports SSL
- requires proper infrastructure (IIS, SqlServer)
- requires .NET Framework 4.5 (I consider this a drawback due to the fact that .NET 4.5 is an in-place upgrade)
- requires you to fetch the sources, compile everything and configure quite a lot in source code and configuration files (and repeat this step if you want to upgrade to a newer version)
- there's a NuGet Gallery Operations Toolkit, but it's not designed nor intended to work with every NuGetGallery installation
The following NuGet clients are being shipped as part of Microsoft products and available as extensions on each product's extension gallery:
- WebMatrix 3 NuGetPackageManager extension:
- NuGet-based Microsoft Package Manager for Visual Studio 2010 and 2012
- NuGet-based Microsoft Package Manager for Visual Studio 2013
One of the developers of the core NuGet team at Microsoft created a great graphical tool to work with NuGet packages. It allows you to very easily create, publish, download and inspect NuGet packages and their metadata.
MyGet is a NuGet server that allows you to create and host your own NuGet feeds. It is hosted on Windows Azure and has a freemium offering, meaning you can use it for free (within the constrains of the free plan) or subscribe to one of the paying plans if you require more resources or features. More info at https://www.myget.org.
- Availability and history: http://status.myget.org.
- Documentation: http://docs.myget.org.
- Twitter: https://twitter.com/mygetteam
- JabbR: https://jabbr.net/#/rooms/myget
- requires no infrastructure
- allows you to get started in a few clicks and focus on the packages instead of the server
- fully compatible with all NuGet client tools
- free software updates (including support for to the latest NuGet version)
- free for open source projects (meeting criteria and within allowed quota)
- publish and promote your feed in the public gallery
- supports NuGet Feed Discovery and Package Source Discovery
- extended feed functionality
- feed visibility (public, readonly or private)
- activity streams
- strict SemVer validation for packages being pushed
- upload packages directly in the browser
- add packages from another feed (upstream package source)
- upstream package source presets for nuget.org (including webmatrix and other curated feeds), chocolatey, teamcity, etc
- filter upstream package sources
- mirror upstream package sources
- package promotion to an upstream package source
- (automatic or manual) package mirroring
- package retention rules
- download entire feeds as ZIP archives for backup purposes
- download packages from the web (without the need for nuget client tools)
- integration with symbolsource (shared credentials and feed/repository security settings)
- multiple endpoints, including the v1-compatible endpoint (e.g. you can use the feed as a custom Orchard Gallery feed)
- granular security
- API key per user
- user-roles on feeds (owner, co-owner, contributor, reader)
- user management (enterprise plan)
- quota management (enterprise plan)
- web site authentication using on-premise ADFS (enterprise plan)
- web site authentication using prefered identity providers: Live ID, Google, GitHub, StackOverflow, etc (enterprise plan)
- build services
- creates the NuGet and symbols packages for you
- customizable automatic-versioning and assembly version patching
- auto-trigger builds for CodePlex, BitBucket or GitHub commits
- support for many unit testing frameworks
- support for many SDKs (including windows phone)
- build failure notifications through email and downloadable build logs
- custom logo and domain name (enterprise plan)
Chocolatey.org is a system-level package manager for Windows based on NuGet, allowing you to search and install software components on your system, even unattended. Looks very promising and definitely something to keep an eye on!
OctopusDeploy is a convention-based automated deployment solution using NuGet as a protocol. You can use the Community edition for free (limited to 1 project) or buy one of the paying editions.
- Documentation: http://octopusdeploy.com/documentation
- Blog: http://octopusdeploy.com/blog
- Twitter: https://twitter.com/OctopusDeploy
- Deployment dashboard
- Scalability through lightweight service agents (tentacles)
- Deployment promotion between environments
- Support for PowerShell scripts
- Support for manual interventions
- Support for XML configuration transforms and variables
- Support for Windows Azure web and worker roles
- Support for (S)FTP
- Has a TeamCity plug-in
- Has a Command Line (octo.exe)
- Has a REST API
- Fine-grained user permissions
- Retention policies
- Automation of common tasks for ASP.NET deployments (IIS configuration) and Windows Services
RedGate's Deployment Manager is a custom fork of the OctopusDeploy project. History separates shortly after v1.0 of OctopusDeploy, as explained in this post.
More info: http://www.red-gate.com/delivery/deployment-manager/
SymbolSource is a hosted symbolserver that integrates with NuGet and is configurable in Visual Studio, allowing you to debug NuGet packages by downloading the symbols and sources on-demand.
The CoApp project originally aimed to create a vibrant Open Source ecosystem on Windows by providing the technologies needed to build a complete community-driven Package Management System, along with tools to enable developers to take advantage of features of the Windows platform.
The project has pivoted to mesh with the NuGet project and the collaborative result is visible in NuGet 2.5 where support for native packages was first introduced. The CoApp project is still building additional tools to enhance C/C++ support in NuGet.
ProGet is an on-premise NuGet server with a freemium model that also provides integration with the Inedo BuildMaster product.
- Documentation: http://inedo.com/support/documentation/table-of-contents
- Twitter: http://twitter.com/inedo
- Compatibility with all NuGet client tools
- Custom proget.exe client tool
- Connectors to other NuGet feeds
- Connector filters
- Support for multiple feeds
- Support for private feeds
- License filtering
- Download feeds and packages
- LDAP authentication to the ProGet web application
- Upload packages to the ProGet web application
- integrated symbols and source server
- SDK and API
- Supports OData
- Supports NuGet Feed Discovery and NuSpec Extensions
BoxStarter is another cool project leveraging NuGet and Chocolatey to quickly set up development environments.
SharpDevelop was amongst the first IDEs other than Visual Studio to support NuGet.
More info: http://community.sharpdevelop.net/blogs/mattward/archive/2011/01/23/NuGetSupportInSharpDevelop.aspx
Xamarin and MonoDevelop
Xamarin Studio and MonoDevelop also have a NuGet extension, built on top of a custom build of the NuGet.Core.dll and a custom build of Microsoft's XML Document Transformation (XDT) library.
More info: https://github.com/mrward/monodevelop-nuget-addin
As of v8.0 of ReSharper, the built-in extension manager allows you to fetch ReSharper plug-in packages from a custom NuGet Gallery hosted at https://resharper-plugins.jetbrains.com.
TeamCity has a few build steps specifically designed to deal with NuGet package consumption, creation and publication. In addition, it also comes with a built-in NuGet feed collecting all packages produced in your build artifacts.
More info: http://blogs.jetbrains.com/dotnet/2011/08/native-nuget-support-in-teamcity/
Artifactory is a repository manager with built-in support for various artifacts, including NuGet packages.
More info: http://www.jfrog.com/confluence/display/RTF/NuGet+Repositories
Nexus is another repository manager with built-in support for NuGet and they even provide a "What is NuGet for Java Developers" on their blog.
More info: http://books.sonatype.com/nexus-book/reference/nuget.html
There are quite a few other tools and utilities building further on top of NuGet. Here's a list of what I've found interesting:
It is great to see how NuGet adoption is growing, especially when people come up with innovative ideas that facilitate our work even further. And if any of you has a way to improve the NuGet tools, whether the Outercurve, Microsoft or any other NuGet-based product, then please tell them about your ideas. Report defects, log feature requests, provide feedback, write documentation or submit a pull request and experience eternal gratitude from an entire community :-)
- August 19th, 2013 - Added NuGet Concierge project
- August 1st, 2013 - Updated Coapp project description
- July 30, 2013 - First published
Xavier Decoster is a .NET/ALM consultant living in Belgium and co-founder of MyGet.org. He co-authored the book Pro NuGet and is a Microsoft Extended Experts Team member in Belgium.
He hates development friction and does not respect time zones. In order to make other developers aware of how frictionless development can and should be, he tries to share his experiences and insights by contributing back to the Community as a speaker, as an author, as a blogger, and through various open source projects.
His blog can be found at http://www.xavierdecoster.com and you can follow him on Twitter.