Oakrey.Git 1.0.0

dotnet add package Oakrey.Git --version 1.0.0
                    
NuGet\Install-Package Oakrey.Git -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="Oakrey.Git" Version="1.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Oakrey.Git" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Oakrey.Git" />
                    
Project file
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 Oakrey.Git --version 1.0.0
                    
#r "nuget: Oakrey.Git, 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.
#addin nuget:?package=Oakrey.Git&version=1.0.0
                    
Install Oakrey.Git as a Cake Addin
#tool nuget:?package=Oakrey.Git&version=1.0.0
                    
Install Oakrey.Git as a Cake Tool

Oakrey.Git

Overview

The Git project provides a framework for interacting with Git repositories programmatically. It leverages the LibGit2Sharp library to perform common Git operations such as branching, committing, fetching, and pushing.

Features

Repository Management:

GitRepositoryDefinition:

  • Represents a Git repository with properties for local and remote paths.
  • Provides access to the LibGit2Sharp.Repository object.

Branch Operations:

BranchCollectionExtensions:

  • Provides methods to retrieve branch names, check if a branch is remote, and get the current local branch.

Commit and Staging:

GitRepositoryExtensions:

  • Includes methods for committing changes, staging files, and resetting the repository.

Fetch and Pull:

FetchResult:

  • Represents the result of a fetch operation, including incoming and outgoing commits.

GitRepositoryExtensions:

  • Provides methods for fetching and pulling changes from remote repositories.

User Authentication:

GitUser:

  • Encapsulates user credentials and author information for Git operations.

Diff and Undo:

GitRepositoryExtensions:

  • Includes methods for generating diffs and undoing changes.

Integration with LibGit2Sharp:

Utilizes the LibGit2Sharp library for low-level Git operations.

Installation

You can install the package via NuGet Package Manager, Package Manager Console or the .NET CLI.

NuGet Package Manager

  1. Open your project in Visual Studio.
  2. Navigate to Tools > NuGet Package Manager > Manage NuGet Packages for Solution....
  3. Search for Oakrey.Git and click Install.

.NET CLI

Run the following command in your terminal:

dotnet add package Oakrey.Git

Package Manager Console

Run the following command in your Package Manager Console:

Install-Package Oakrey.Git

Requirements

  • .NET 8 or higher

Project Information

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to improve the package.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  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.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Oakrey.Git:

Package Downloads
Oakrey.Applications.Git

A .NET library for managing Git repositories programmatically, supporting operations like cloning, committing, and branching, with integrated logging and telemetry.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0 202 4/16/2025