NuGet.Packaging 6.10.1

Prefix Reserved
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package NuGet.Packaging --version 6.10.1                
NuGet\Install-Package NuGet.Packaging -Version 6.10.1                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="NuGet.Packaging" Version="6.10.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add NuGet.Packaging --version 6.10.1                
#r "nuget: NuGet.Packaging, 6.10.1"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install NuGet.Packaging as a Cake Addin
#addin nuget:?package=NuGet.Packaging&version=6.10.1

// Install NuGet.Packaging as a Cake Tool
#tool nuget:?package=NuGet.Packaging&version=6.10.1                

Nuget.Packaging

NuGet.Packaging is a NuGet client SDK library that provides a set of APIs to interact with .nupkg and .nuspec files from a stream. It provides a way for developers to create and read packages and work with the package metadata.

Usage

It is strongly recommended that NuGet packages are created using the official NuGet tooling and instead of this low-level API. There are a variety of characteristics important for a well-formed package and the latest version of tooling helps incorporate these best practices.

For more information about creating NuGet packages, see the overview of the package creation workflow and the documentation for official pack tooling (for example, using the dotnet CLI).

Examples

Create a package

Create a package, set metadata, and add dependencies.

PackageBuilder builder = new PackageBuilder();
builder.Id = "MyPackage";
builder.Version = new NuGetVersion("1.0.0-beta");
builder.Description = "My package created from the API.";
builder.Authors.Add("Sample author");
builder.DependencyGroups.Add(new PackageDependencyGroup(
    targetFramework: NuGetFramework.Parse("netstandard1.4"),
    packages: new[]
    {
        new PackageDependency("Newtonsoft.Json", VersionRange.Parse("10.0.1"))
    }));

using FileStream outputStream = new FileStream("MyPackage.nupkg", FileMode.Create);
builder.Save(outputStream);
Console.WriteLine($"Saved a package to {outputStream.Name}");

Read a package

Read a package from a file.

using FileStream inputStream = new FileStream("MyPackage.nupkg", FileMode.Open);
using PackageArchiveReader reader = new PackageArchiveReader(inputStream);
NuspecReader nuspec = reader.NuspecReader;
Console.WriteLine($"ID: {nuspec.GetId()}");
Console.WriteLine($"Version: {nuspec.GetVersion()}");
Console.WriteLine($"Description: {nuspec.GetDescription()}");
Console.WriteLine($"Authors: {nuspec.GetAuthors()}");

Console.WriteLine("Dependencies:");
foreach (PackageDependencyGroup dependencyGroup in nuspec.GetDependencyGroups())
{
    Console.WriteLine($" - {dependencyGroup.TargetFramework.GetShortFolderName()}");
    foreach (var dependency in dependencyGroup.Packages)
    {
        Console.WriteLine($"   > {dependency.Id} {dependency.VersionRange}");
    }
}

Additional documentation

More information about the NuGet.Packaging library can be found on the official Microsoft documentation page and NuGet API docs.

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 is compatible.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (115)

Showing the top 5 NuGet packages that depend on NuGet.Packaging:

Package Downloads
Microsoft.VisualStudio.Web.CodeGenerators.Mvc

Code Generators for ASP.NET Core MVC. Contains code generators for MVC Controllers and Views.

Microsoft.VisualStudio.Web.CodeGeneration.Design

Code Generation tool for ASP.NET Core. Contains the dotnet-aspnet-codegenerator command used for generating controllers and views.

Microsoft.VisualStudio.Web.CodeGeneration

Contains the CodeGenCommand that finds the appropriate code generator and invokes it from project dependencies.

Microsoft.VisualStudio.Web.CodeGeneration.EntityFrameworkCore

Contains Entity Framework Core Services used by ASP.NET Core Code Generators.

Microsoft.VisualStudio.Web.CodeGeneration.Core

Contains the core infrastructure used by ASP.NET Core Code Generators.

GitHub repositories (53)

Showing the top 5 popular GitHub repositories that depend on NuGet.Packaging:

Repository Stars
dotnet/aspnetcore
ASP.NET Core is a cross-platform .NET framework for building modern cloud-based web applications on Windows, Mac, or Linux.
dotnet/runtime
.NET is a cross-platform runtime for cloud, mobile, desktop, and IoT apps.
elsa-workflows/elsa-core
A .NET workflows library
dotnet/Open-XML-SDK
Open XML SDK by Microsoft
cake-build/cake
:cake: Cake (C# Make) is a cross platform build automation system.
Version Downloads Last updated
6.11.0-preview.2 1,226 6/5/2024
6.10.1 49,919 6/27/2024
6.10.0 162,302 5/21/2024
6.9.1 2,796,910 2/13/2024
6.8.1 65,408 2/13/2024
6.8.0 1,028,667 11/17/2023
6.7.1 77,887 2/14/2024
6.7.0 1,818,470 8/9/2023
6.6.2 58,771 2/13/2024
6.6.1 5,554,649 6/13/2023
6.6.0 107,163 5/17/2023
6.6.0-preview.3 730 5/17/2023
6.5.1 104,865 6/13/2023
6.5.0 410,050 2/22/2023
6.4.3 19,018 2/13/2024
6.4.2 131,286 6/13/2023
6.4.0 957,633 11/9/2022
6.3.4 62,255 2/13/2024
6.3.3 175,232 6/14/2023
6.3.1 13,988,794 10/11/2022
6.2.4 49,286 6/14/2023
6.2.2 54,729 10/11/2022
6.1.0 648,719 2/16/2022
6.0.6 10,212 2/13/2024
6.0.5 95,207 6/13/2023
6.0.3-rc.1 733 10/11/2022
6.0.2 15,427 6/14/2022
5.11.6 101,552 2/13/2024
5.11.5 2,184,749 6/15/2023
5.11.3 312,117 10/11/2022
5.10.0 3,879,400 6/15/2021
5.9.3 122,797 10/11/2022
5.8.1 220,918 1/16/2021
5.7.3-rtm.5 485 10/11/2022
5.7.2 9,523 6/14/2022
5.6.0 3,979,016 5/20/2020
5.5.1 1,332,699 4/3/2020
5.4.0 607,237 12/3/2019
5.3.1 6,653,347 10/25/2019
5.2.1 547 6/14/2022
5.1.0 255,313 5/21/2019
5.0.2 34,697 5/14/2019
4.9.6 6,989 10/11/2022
4.8.2 37,510 3/12/2019
4.7.3 1,019 3/15/2019
4.6.4 17,110 3/15/2019
4.5.3 18,340 3/15/2019
4.4.3 910 3/15/2019
4.3.1 17,411 3/12/2019
4.2.0 763,457 7/14/2017
4.1.0 11,227 7/14/2017
4.0.0 215,056 3/7/2017
3.5.0 497,586 12/14/2016
3.4.4-rtm-final 4,001 6/3/2016
3.4.3 18,214 4/22/2016
3.3.0 138,249 12/1/2015
3.2.0 25,710 9/16/2015