NuGet.Protocol
6.12.1
Prefix Reserved
dotnet add package NuGet.Protocol --version 6.12.1
NuGet\Install-Package NuGet.Protocol -Version 6.12.1
<PackageReference Include="NuGet.Protocol" Version="6.12.1" />
paket add NuGet.Protocol --version 6.12.1
#r "nuget: NuGet.Protocol, 6.12.1"
// Install NuGet.Protocol as a Cake Addin #addin nuget:?package=NuGet.Protocol&version=6.12.1 // Install NuGet.Protocol as a Cake Tool #tool nuget:?package=NuGet.Protocol&version=6.12.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 | Versions 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. |
-
.NETFramework 4.7.2
- NuGet.Packaging (>= 6.12.1)
- System.Text.Json (>= 8.0.4)
-
.NETStandard 2.0
- NuGet.Packaging (>= 6.12.1)
- System.Text.Json (>= 8.0.4)
-
net5.0
- NuGet.Packaging (>= 6.12.1)
NuGet packages (134)
Showing the top 5 NuGet packages that depend on NuGet.Protocol:
Package | Downloads |
---|---|
NuGet.DependencyResolver.Core
NuGet's PackageReference dependency resolver implementation. |
|
NuGet.Resolver
NuGet's dependency resolver for packages.config based projects. |
|
Microsoft.CodeAnalysis.Analyzer.Testing
Roslyn Analyzer Test Framework Common Types. |
|
NuGet.Credentials
NuGet client's authentication models. |
|
Cake.NuGet
Cake Module providing NuGet install capabilities for i.e. preprocessor directives like #addin, #tool and #load |
GitHub repositories (85)
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 (formerly Xenko), a free and open-source cross-platform C# game engine.
|
|
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.12.1 | 69,193 | 11/12/2024 | |
6.12.0 | 812 | 11/12/2024 | |
6.11.1 | 204,904 | 10/1/2024 | |
6.11.0 | 1,777,515 | 8/13/2024 | |
6.11.0-preview.2 | 2,469 | 6/5/2024 | |
6.10.2 | 10,985 | 8/12/2024 | |
6.10.1 | 328,842 | 6/27/2024 | |
6.10.0 | 334,995 | 5/21/2024 | |
6.9.1 | 6,623,944 | 2/13/2024 | |
6.8.1 | 47,354 | 2/13/2024 | |
6.8.0 | 1,177,929 | 11/17/2023 | |
6.7.1 | 115,523 | 2/14/2024 | |
6.7.0 | 1,320,171 | 8/9/2023 | |
6.6.2 | 21,668 | 2/13/2024 | |
6.6.1 | 6,862,867 | 6/13/2023 | |
6.6.0 | 75,007 | 5/17/2023 | |
6.6.0-preview.3 | 890 | 5/17/2023 | |
6.5.1 | 139,981 | 6/13/2023 | |
6.5.0 | 383,721 | 2/22/2023 | |
6.4.3 | 25,817 | 2/13/2024 | |
6.4.2 | 154,551 | 6/13/2023 | |
6.4.0 | 941,244 | 11/9/2022 | |
6.3.4 | 409,712 | 2/13/2024 | |
6.3.3 | 212,500 | 6/14/2023 | |
6.3.1 | 15,594,145 | 10/11/2022 | |
6.2.4 | 49,428 | 6/14/2023 | |
6.2.2 | 52,277 | 10/11/2022 | |
6.1.0 | 619,284 | 2/16/2022 | |
6.0.6 | 12,998 | 2/13/2024 | |
6.0.5 | 102,006 | 6/13/2023 | |
6.0.3-rc.1 | 930 | 10/11/2022 | |
6.0.2 | 14,194 | 6/14/2022 | |
5.11.6 | 106,299 | 2/13/2024 | |
5.11.5 | 2,999,009 | 6/15/2023 | |
5.11.3 | 319,684 | 10/11/2022 | |
5.10.0 | 3,877,856 | 6/15/2021 | |
5.9.3 | 123,821 | 10/11/2022 | |
5.8.1 | 198,882 | 1/16/2021 | |
5.7.3-rtm.5 | 675 | 10/11/2022 | |
5.7.2 | 9,155 | 6/14/2022 | |
5.6.0 | 4,129,000 | 5/20/2020 | |
5.5.1 | 104,192 | 4/3/2020 | |
5.4.0 | 378,769 | 12/3/2019 | |
5.3.1 | 292,366 | 10/25/2019 | |
5.2.1 | 692 | 6/14/2022 | |
5.1.0 | 248,219 | 5/21/2019 | |
5.0.2 | 36,165 | 5/14/2019 | |
4.9.6 | 8,146 | 10/11/2022 | |
4.8.2 | 37,755 | 3/12/2019 | |
4.7.3 | 1,091 | 3/15/2019 | |
4.6.4 | 12,477 | 3/15/2019 | |
4.5.3 | 22,705 | 3/15/2019 | |
4.4.3 | 911 | 3/15/2019 | |
4.3.1 | 9,932 | 3/12/2019 |