NuGet.Protocol 6.11.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.
Showing the top 20 packages that depend on NuGet.Protocol.
Packages | Downloads |
---|---|
NuGet.DependencyResolver.Core
NuGet client library.
|
59 |
NuGet.DependencyResolver.Core
NuGet's PackageReference dependency resolver implementation.
|
57 |
NuGet.DependencyResolver.Core
NuGet client library.
|
52 |
NuGet.DependencyResolver.Core
NuGet client library.
|
51 |
NuGet.DependencyResolver.Core
NuGet client library.
|
49 |
NuGet.DependencyResolver.Core
NuGet's PackageReference dependency resolver implementation.
|
48 |
NuGet.DependencyResolver.Core
NuGet client library.
|
47 |
NuGet.DependencyResolver.Core
NuGet's PackageReference dependency resolver implementation.
|
47 |
NuGet.DependencyResolver.Core
NuGet client library.
|
46 |
NuGet.DependencyResolver.Core
NuGet's PackageReference dependency resolver implementation.
|
45 |
NuGet.DependencyResolver.Core
NuGet client library.
|
45 |
.NET Framework 4.7.2
- NuGet.Packaging (>= 6.11.1)
- System.Text.Json (>= 7.0.3)
.NET 5.0
- NuGet.Packaging (>= 6.11.1)
.NET Standard 2.0
- NuGet.Packaging (>= 6.11.1)
- System.Text.Json (>= 7.0.3)
Version | Downloads | Last updated |
---|---|---|
6.11.1 | 9 | 10/4/2024 |
6.11.0 | 18 | 8/14/2024 |
6.11.0-preview.2 | 15 | 6/6/2024 |
6.10.2 | 11 | 8/12/2024 |
6.10.1 | 19 | 6/27/2024 |
6.10.0 | 14 | 5/22/2024 |
6.9.1 | 18 | 2/24/2024 |
6.8.1 | 20 | 2/24/2024 |
6.8.0 | 25 | 11/24/2023 |
6.7.1 | 19 | 2/24/2024 |
6.7.0 | 26 | 8/24/2023 |
6.6.2 | 20 | 2/22/2024 |
6.6.1 | 29 | 8/4/2023 |
6.6.0 | 27 | 5/20/2023 |
6.6.0-preview.3 | 28 | 5/20/2023 |
6.5.1 | 26 | 8/4/2023 |
6.5.0 | 29 | 2/25/2023 |
6.4.3 | 20 | 2/22/2024 |
6.4.2 | 25 | 7/30/2023 |
6.4.0 | 27 | 11/17/2022 |
6.3.4 | 20 | 2/24/2024 |
6.3.3 | 28 | 8/4/2023 |
6.3.1 | 26 | 12/7/2022 |
6.3.0 | 33 | 9/18/2022 |
6.2.4 | 26 | 7/12/2023 |
6.2.2 | 25 | 12/7/2022 |
6.2.1 | 31 | 6/30/2022 |
6.2.0 | 35 | 7/1/2022 |
6.1.0 | 31 | 7/1/2022 |
6.0.6 | 20 | 2/24/2024 |
6.0.5 | 25 | 7/17/2023 |
6.0.3-rc.1 | 33 | 12/7/2022 |
6.0.2 | 29 | 7/1/2022 |
6.0.0 | 30 | 7/1/2022 |
6.0.0-preview.4.243 | 34 | 7/1/2022 |
6.0.0-preview.3 | 41 | 7/1/2022 |
5.11.6 | 19 | 2/25/2024 |
5.11.5 | 24 | 8/4/2023 |
5.11.3 | 29 | 12/7/2022 |
5.11.2 | 25 | 7/1/2022 |
5.11.0 | 30 | 7/1/2022 |
5.10.0 | 29 | 7/1/2022 |
5.10.0-preview.2.7185 | 39 | 7/1/2022 |
5.9.3 | 35 | 11/9/2022 |
5.9.2 | 26 | 7/1/2022 |
5.9.1 | 32 | 7/1/2022 |
5.9.0 | 33 | 7/1/2022 |
5.9.0-preview.2 | 30 | 7/1/2022 |
5.8.1 | 41 | 7/1/2022 |
5.8.0 | 32 | 7/1/2022 |
5.8.0-preview.3.6823 | 32 | 7/1/2022 |
5.8.0-preview.2.6776 | 45 | 7/1/2022 |
5.8.0-preview.1 | 39 | 7/1/2022 |
5.7.3-rtm.5 | 28 | 12/7/2022 |
5.7.2 | 37 | 7/1/2022 |
5.7.1 | 28 | 7/1/2022 |
5.7.0 | 27 | 7/1/2022 |
5.7.0-rtm.6702 | 32 | 7/1/2022 |
5.7.0-preview.3.6653 | 38 | 7/1/2022 |
5.7.0-preview.2.6618 | 33 | 7/1/2022 |
5.7.0-preview.1.6592 | 33 | 7/1/2022 |
5.6.0 | 39 | 7/1/2022 |
5.6.0-preview.3.6558 | 43 | 7/1/2022 |
5.6.0-preview.2.6489 | 45 | 7/1/2022 |
5.6.0-preview.1.6483 | 46 | 7/1/2022 |
5.5.1 | 31 | 7/1/2022 |
5.5.0 | 34 | 7/1/2022 |
5.5.0-preview.2.6382 | 40 | 7/1/2022 |
5.5.0-preview.1.6319 | 31 | 7/1/2022 |
5.4.0 | 36 | 7/1/2022 |
5.3.1 | 33 | 7/1/2022 |
5.3.0 | 29 | 7/1/2022 |
5.3.0-rtm.6192 | 37 | 7/1/2022 |
5.2.1 | 39 | 7/1/2022 |
5.2.0 | 36 | 7/1/2022 |
5.1.0 | 45 | 7/1/2022 |
5.1.0-preview2.5965 | 32 | 7/1/2022 |
5.0.2 | 31 | 7/1/2022 |
5.0.0 | 36 | 7/1/2022 |
5.0.0-rtm.5867 | 30 | 7/1/2022 |
5.0.0-rtm.5856 | 41 | 7/1/2022 |
5.0.0-preview3.5800 | 36 | 7/1/2022 |
5.0.0-preview2.5782 | 37 | 7/1/2022 |
4.9.6 | 26 | 11/5/2022 |
4.9.5 | 39 | 7/1/2022 |
4.9.4 | 29 | 7/1/2022 |
4.9.3 | 31 | 7/1/2022 |
4.9.2 | 33 | 7/1/2022 |
4.9.2-rtm.5706 | 38 | 7/1/2022 |
4.9.1 | 29 | 7/1/2022 |
4.9.0-rtm.5658 | 33 | 7/1/2022 |
4.8.2 | 30 | 7/1/2022 |
4.8.0 | 40 | 7/1/2022 |
4.8.0-rtm.5362 | 35 | 7/1/2022 |
4.8.0-preview3.5278 | 36 | 7/1/2022 |
4.8.0-preview1.5156 | 31 | 7/1/2022 |
4.7.3 | 39 | 7/1/2022 |
4.7.2 | 36 | 7/1/2022 |
4.7.0 | 40 | 7/1/2022 |
4.7.0-rtm.5148 | 38 | 7/1/2022 |
4.7.0-rtm.5104 | 31 | 7/1/2022 |
4.7.0-preview4.5065 | 28 | 7/1/2022 |
4.7.0-preview1-4986 | 38 | 7/1/2022 |
4.6.4 | 37 | 7/1/2022 |
4.6.3 | 36 | 7/1/2022 |
4.6.2 | 40 | 7/1/2022 |
4.6.1 | 31 | 7/1/2022 |
4.6.0 | 32 | 7/1/2022 |
4.6.0-rtm-4918 | 33 | 7/1/2022 |
4.6.0-rtm-4825 | 34 | 7/1/2022 |
4.6.0-rtm-4791 | 28 | 7/1/2022 |
4.5.3 | 35 | 7/1/2022 |
4.5.2 | 28 | 7/1/2022 |
4.5.0 | 33 | 7/1/2022 |
4.5.0-rtm-4651 | 42 | 7/1/2022 |
4.4.3 | 36 | 7/1/2022 |
4.4.2 | 35 | 7/1/2022 |
4.4.0 | 29 | 7/1/2022 |
4.4.0-preview3-4475 | 35 | 7/1/2022 |
4.3.1 | 29 | 7/1/2022 |
4.3.0 | 29 | 7/1/2022 |
4.3.0-rtm-4324 | 37 | 7/1/2022 |
4.3.0-preview4 | 44 | 7/1/2022 |
4.3.0-preview3-4168 | 43 | 7/1/2022 |