Read NuGet v3 feed catalogs, mirror packages to disk, and query package metadata.

	NuGet.CatalogReader	NuGetMirror
Package
Downloads

• Overview
• Prerequisites
• Installation
• NuGetMirror CLI tool
  • Mirror packages (nupkgs)
  • List packages (list)
  • Auth support
• NuGet.CatalogReader library
  • Reading catalog entries
  • Time range filtering
  • Reading feeds without a catalog
  • Download modes
  • API overview
• Building from source
• Contributing
• License

This repository contains two packages:

• NuGet.CatalogReader — A library for reading package ids, versions, and the change history of NuGet v3 feeds or nuget.org.
• NuGetMirror — A command line tool to mirror nuget.org (or any NuGet v3 feed) to disk. Supports filtering by package id and wildcards.

• .NET 8.0, 9.0, or 10.0 SDK

dotnet add package NuGet.CatalogReader

dotnet tool install -g nugetmirror

After installation, nugetmirror will be available on your PATH.

Mirror all packages to a folder on disk:

nugetmirror nupkgs https://api.nuget.org/v3/index.json -o /tmp/packages

NuGetMirror stores the last commit time to disk so that future runs resume from that point and only download new or updated packages.

Mirror only packages matching a wildcard:

nugetmirror nupkgs https://api.nuget.org/v3/index.json -o /tmp/packages -i "Newtonsoft.*"

Mirror stable-only, latest versions:

nugetmirror nupkgs https://api.nuget.org/v3/index.json -o /tmp/packages --latest-only --stable-only

List all packages in a feed:

nugetmirror list https://api.nuget.org/v3/index.json

NuGetMirror can use credentials from a nuget.config file. Pass the source name instead of the index.json URI and ensure that the config is in the working directory or one of the common nuget.config locations.

nugetmirror nupkgs MyPrivateFeed -o /tmp/packages

With a nuget.config like:

<packageSources>
  <add key="MyPrivateFeed" value="https://myfeed.example.com/v3/index.json" />
</packageSources>
<packageSourceCredentials>
  <MyPrivateFeed>
    <add key="Username" value="user" />
    <add key="ClearTextPassword" value="token" />
  </MyPrivateFeed>
</packageSourceCredentials>

Discover all packages in a feed using GetFlattenedEntriesAsync. To see the complete history including edits, use GetEntriesAsync.

var feed = new Uri("https://api.nuget.org/v3/index.json");

using (var catalog = new CatalogReader(feed))
{
    foreach (var entry in await catalog.GetFlattenedEntriesAsync())
    {
        Console.WriteLine($"[{entry.CommitTimeStamp}] {entry.Id} {entry.Version}");
    }
}

Retrieve entries within a specific time range:

var feed = new Uri("https://api.nuget.org/v3/index.json");

using (var catalog = new CatalogReader(feed))
{
    var start = DateTimeOffset.UtcNow.AddHours(-1);
    var end = DateTimeOffset.UtcNow;

    foreach (var entry in await catalog.GetEntriesAsync(start, end, CancellationToken.None))
    {
        Console.WriteLine($"[{entry.CommitTimeStamp}] {entry.Id} {entry.Version}");
    }
}

NuGet v3 feeds that do not have a catalog can be read using FeedReader:

var feed = new Uri("https://api.nuget.org/v3/index.json");

using (var feedReader = new FeedReader(feed))
{
    foreach (var entry in await feedReader.GetPackagesById("NuGet.Versioning"))
    {
        Console.WriteLine($"{entry.Id} {entry.Version}");
        await entry.DownloadNupkgAsync("/tmp/output");
    }
}

When downloading packages, specify how to handle existing files with DownloadMode:

await entry.DownloadNupkgAsync("/tmp/output", DownloadMode.SkipIfExists, CancellationToken.None);

Clone the repository and run the build script for your platform:

# macOS / Linux
./build.sh

# Windows
./build.ps1

The build script will install the required .NET SDKs locally, restore packages, build, pack, and run tests.

We welcome contributions. If you are interested in contributing you can report an issue or open a pull request to propose a change.

MIT License