Rag.NET.DataProviders.GitHub
1.0.0
dotnet add package Rag.NET.DataProviders.GitHub --version 1.0.0
NuGet\Install-Package Rag.NET.DataProviders.GitHub -Version 1.0.0
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="Rag.NET.DataProviders.GitHub" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Rag.NET.DataProviders.GitHub" Version="1.0.0" />
<PackageReference Include="Rag.NET.DataProviders.GitHub" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Rag.NET.DataProviders.GitHub --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Rag.NET.DataProviders.GitHub, 1.0.0"
#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.
#:package Rag.NET.DataProviders.GitHub@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Rag.NET.DataProviders.GitHub&version=1.0.0
#tool nuget:?package=Rag.NET.DataProviders.GitHub&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Rag.NET.DataProviders.GitHub
GitHub repository connector for Rag.NET ingestion, built on Octokit: streams a branch's files into the pipeline, with commit-SHA deltas so subsequent runs only fetch what changed — and the blob SHA as ETag, guaranteeing byte-identical content is never re-ingested.
Install
dotnet add package Rag.NET.DataProviders.GitHub
Setup
This connector is constructed directly (no DI extension method) so you control the Octokit client:
using Microsoft.Extensions.DependencyInjection;
using Octokit;
using Rag.NET.Abstractions;
using Rag.NET.DataProviders.GitHub;
var gitHubClient = new GitHubClient(new ProductHeaderValue("my-app"))
{
Credentials = new Credentials(Environment.GetEnvironmentVariable("GITHUB_TOKEN")!),
};
var provider = new GitHubDataProvider(
owner: "my-org",
repo: "my-repo",
client: gitHubClient,
options: new GitHubDataProviderOptions
{
Branch = "main",
Extensions = [".md", ".cs"],
LastIngestedCommitSha = savedCommitSha, // null on first run = full traversal
});
services.AddSingleton<IFileContentProvider>(provider);
Example
using Rag.NET.DataProviders;
using Rag.NET.Models;
var result = await pipeline.IngestFromProviderAsync(provider, new ProviderId("github"), hashStore);
Console.WriteLine($"Ingested {result.Ingested}, skipped {result.Skipped}");
// Persist the branch HEAD SHA after an error-free run for the next delta.
Full guide
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- Octokit (>= 14.0.0)
- Rag.NET.DataProviders (>= 1.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.