Fenrir

Fenrir is a .NET library to work with Git repositories. It provides functions to read Git objects, traverse the commit graph, extract trees and files from any commit, etc. Essentially, it provides tools to create your own Git client or transform a repository in any way.

[!CAUTION] Some of Fenrir's functions perform inline modifications of Git repositories and may destroy information and even commit history!

Always make sure to take a backup before using Fenrir on important data!

Usage

Fenrir is a .NET library, and thus you can install it into your program via NuGet. Visit the package's page on nuget.org, or install the Fenrir.Git library using your preferred .NET package management tool.

Read the API reference to know more of the usage patterns. While Fenrir is written in F#, it provides an API friendly to other .NET languages.

Fenrir also provides a terminal tool, Fenrir.Application, as a showcase of what is possible to do using the library. Download the application from the releases section, and see the separate documentation file on the application.

If you are looking for some usage examples, check the GitRepositoryModel.fs file, or see the API documentation.

Versioning Policy

This project's versioning follows the Semantic Versioning 2.0.0 specification. Only changes in the NuGet package are considered. The example application can change at any time.

Documentation

• Changelog
• Contributor Guide
• Maintainer Guide

License

The project is distributed under the terms of the MIT license.

The license indication in the project's sources is compliant with the REUSE specification v3.3.