NuGet.Protocol 6.9.1

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
dotnet add package NuGet.Protocol --version 6.9.1
NuGet\Install-Package NuGet.Protocol -Version 6.9.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.Protocol" Version="6.9.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add NuGet.Protocol --version 6.9.1
#r "nuget: NuGet.Protocol, 6.9.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.Protocol as a Cake Addin
#addin nuget:?package=NuGet.Protocol&version=6.9.1

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

NuGet.Protocol

NuGet.Protocol is a NuGet client SDK library that provides a set of APIs for interacting with NuGet feeds. It provides a way for developers to query NuGet feeds to discover packages and their dependencies, and also to download packages and their associated assets.

Usage

At the center of this library are the PackageSource and SourceRepository types, which represent a NuGet source that may be a file source or an http based source implementing the V2 or V3 protocol.

PackageSource localSource = new PackageSource(@"D:\LocalSource");
SourceRepository localRepository = Repository.Factory.GetCoreV3(localSource);

SourceRepository repository = Repository.Factory.GetCoreV3("https://api.nuget.org/v3/index.json");

The SourceRepository then has a GetResourceAsync method that you can use to acquire implementations of INuGetResource that often are V3 resources.

FindPackageByIdResource resource = await repository.GetResourceAsync<FindPackageByIdResource>(); 

Examples

Search packages

Search for "json" packages using the NuGet V3 Search API:

PackageSearchResource resource = await repository.GetResourceAsync<PackageSearchResource>();
SearchFilter searchFilter = new SearchFilter(includePrerelease: true);

IEnumerable<IPackageSearchMetadata> results = await resource.SearchAsync(
    "json",
    searchFilter,
    skip: 0,
    take: 20,
    NullLogger.Instance,
    CancellationToken.None);

Download a package

Download Newtonsoft.Json v12.0.1 using the NuGet V3 Package Content API:

FindPackageByIdResource resource = await repository.GetResourceAsync<FindPackageByIdResource>();

string packageId = "Newtonsoft.Json";
NuGetVersion packageVersion = new NuGetVersion("12.0.1");
using MemoryStream packageStream = new MemoryStream();

await resource.CopyNupkgToStreamAsync(
    packageId,
    packageVersion,
    packageStream,
    new SourceCacheContext(),
    NullLogger.Instance,
    CancellationToken.None);

Push a package

Push a package using the NuGet V3 Push and Delete API:

PackageUpdateResource resource = await repository.GetResourceAsync<PackageUpdateResource>();

await resource.Push(
    "MyPackage.nupkg",
    symbolSource: null,
    timeoutInSecond: 5 * 60,
    disableBuffering: false,
    getApiKey: packageSource => "my-api-key",
    getSymbolApiKey: packageSource => null,
    noServiceEndpoint: false,
    skipDuplicate: false,
    symbolPackageUpdateResource: null,
    NullLogger.Instance);

Additional documentation

More information about the NuGet.Protocol 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)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (120)

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

Package Downloads
NuGet.DependencyResolver.Core The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

NuGet's PackageReference dependency resolver implementation.

NuGet.Resolver The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

NuGet's dependency resolver for packages.config based projects.

NuGet.Credentials The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

NuGet client's authentication models.

Microsoft.CodeAnalysis.Analyzer.Testing The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Roslyn Analyzer Test Framework Common Types.

GitOps.Apps.Debugger

Package Description

GitHub repositories (67)

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

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.
icsharpcode/ILSpy
.NET Decompiler with support for PDB generation, ReadyToRun, Metadata (&more) - cross-platform!
stride3d/stride
Stride Game Engine (formerly Xenko)
elsa-workflows/elsa-core
A .NET workflows library
EventStore/EventStore
EventStoreDB, the event-native database. Designed for Event Sourcing, Event-Driven, and Microservices architectures
Version Downloads Last updated
6.9.1 16,382 2/13/2024
6.8.1 1,050 2/13/2024
6.8.0 536,058 11/17/2023
6.7.1 1,575 2/14/2024
6.7.0 630,075 8/9/2023
6.6.2 605 2/13/2024
6.6.1 3,497,747 6/13/2023
6.6.0 57,799 5/17/2023
6.6.0-preview.3 339 5/17/2023
6.5.1 59,790 6/13/2023
6.5.0 343,122 2/22/2023
6.4.3 897 2/13/2024
6.4.2 98,893 6/13/2023
6.4.0 860,244 11/9/2022
6.3.4 773 2/13/2024
6.3.3 137,065 6/14/2023
6.3.1 10,276,274 10/11/2022
6.2.4 30,483 6/14/2023
6.2.2 41,674 10/11/2022
6.1.0 567,699 2/16/2022
6.0.6 897 2/13/2024
6.0.5 59,217 6/13/2023
6.0.3-rc.1 669 10/11/2022
6.0.2 11,632 6/14/2022
5.11.6 1,184 2/13/2024
5.11.5 1,264,741 6/15/2023
5.11.3 301,629 10/11/2022
5.10.0 3,832,566 6/15/2021
5.9.3 115,449 10/11/2022
5.8.1 179,844 1/16/2021
5.7.3-rtm.5 407 10/11/2022
5.7.2 7,211 6/14/2022
5.6.0 2,625,960 5/20/2020
5.5.1 101,372 4/3/2020
5.4.0 362,255 12/3/2019
5.3.1 289,947 10/25/2019
5.2.1 406 6/14/2022
5.1.0 244,514 5/21/2019
5.0.2 34,982 5/14/2019
4.9.6 5,257 10/11/2022
4.8.2 37,084 3/12/2019
4.7.3 732 3/15/2019
4.6.4 10,674 3/15/2019
4.5.3 14,829 3/15/2019
4.4.3 641 3/15/2019
4.3.1 7,488 3/12/2019