GitDotNet 0.1.81-alpha

GitDotNet is a .NET library designed to read Git repositories in a fully native .NET environment. It is optimized for minimal memory footprint and efficient data retrieval from repositories.

It also supports writing, but it doesn't write itself: it uses git fast-import to write objects and refs to the repository. This guarantees best writing performance, safe git data writing, and avoid having to reinvent the wheel (object compression...).

Features

• Supports .NET 8 and 9. Note that .NET 9 is highly recommended because it uses zlib-ng which is much faster.
• Reade and parses Git objects (commits, trees, blobs, tags, index...) natively in .NET, using memory-mapped files or in-memory data for high performance.
• In-memory data uses IMemoryCache and can use max size & prioritization to control memory footprint.
• Writes in pack files when committing large number of changes.
• Asynchronous methods for efficient data retrieval.
• Minimal memory footprint with lazy loading of data and usage of data streaming.
• Comparison of git commits and trees, along with renaming detection and git patch creation.

<details> <summary>Detailed status...</summary> As per high-level git features, the following is the current status of the project:

• : GitConnection.Create(path, isBare)
• : connection.Branches["main"].Fetch()
• blame
• push
• reset
• status
• (including renaming detection): connection.CompareAsync("HEAD~10", "HEAD")
• merge
  • blobs
  • trees
  • commits
• rebase
• await connection.CommitAsync("main", c => c.AddOrUpdate("test.txt", Encoding.UTF8.GetBytes("foo")), connection.CreateCommit(...))
• worktree checkout
• worktree stream
• : connection.GetLogAsync("HEAD~1", LogOptions.Default with { ... }), await (foreach commint in connection.Branches["fix/bug"])
• : connection.GetAsync<BlobEntry>("1aad9b571c0b84031191ab76e06fae4ba1f981bc")
• : connection.Index.GetEntriesAsync()
• (writes in loose of pack objects, depending on commit change count): connection.CommitAsync("main", c => c.AddOrUpdate("test.txt", Encoding.UTF8.GetBytes("foo")), connection.CreateCommit(...))
• writing of .git/index
• : connection.Config.GetProperty("user", "email")
• writing of git configuration

Note that the main purpose of DotNetGit is to provide high speed reading. Writing can be done through commands. </details>

Installation

To install GitDotNet, add the GitDotNet or GitDotNet.Microsoft.Extensions.DependencyInjection NuGet package to your project.

Usage

1. Add GitDotNet dependencies to your IServiceCollection using the AddGitDotNet extension method. This will inject ConnectionProvider and other required services.
2. Use the Objects.GetAsync method to retrieve Git objects by their hash.
3. Use the provided methods to parse and display the content of commits, trees, blobs, and tags.

using Microsoft.Extensions.DependencyInjection;
using GitDotNet;

var services = new ServiceCollection()
 .AddMemoryCache(o => o.SizeLimit = 10_000_000) // Each entry size is always 1
 .AddGitDotNet();
var provider = services.BuildServiceProvider().GetRequiredService<GitConnectionProvider>();

using var connection = await provider("path/to/repo");
var commit = await connection.Branches["main"].Tip;
Console.WriteLine($"Commit Message: {commit.Message}");

var tree = await commit.GetTreeAsync();

Benchmarks

GitDotNet vs. LibGit2Sharp: reading random blobs of size from 1kB to 3kB

GitDotNet vs. native git 2.47.1.windows.1: archiving git repository

Contributing

Contributions are welcome! Please open an issue or submit a pull request on GitHub.

License

This project is licensed under the MIT License.