Skip to content

octokit/octokit.net

Folders and files

NameName
Last commit message
Last commit date
Feb 7, 2023
Feb 15, 2024
Jun 5, 2024
Dec 27, 2024
Jan 8, 2025
Apr 15, 2024
Jan 8, 2025
Nov 25, 2024
Jan 8, 2025
Jan 8, 2025
Jan 8, 2025
Oct 30, 2024
Jun 24, 2024
May 2, 2017
Jun 16, 2023
Feb 10, 2020
Dec 11, 2014
Dec 27, 2024
Jan 9, 2017
Feb 5, 2024
Jun 26, 2016
Oct 31, 2022
Oct 10, 2022
Feb 9, 2020
Jun 9, 2020
Aug 16, 2017
Mar 26, 2020
Mar 14, 2016
Jan 28, 2017
Jun 10, 2024
Feb 25, 2021
Apr 22, 2014
Jan 24, 2024
Feb 5, 2024
Feb 1, 2024
Feb 9, 2020
Sep 17, 2019
Oct 10, 2022
Apr 28, 2023
Aug 24, 2017

Repository files navigation

Octokit - GitHub API Client Library for .NET

Build status codecov Join the chat at https://gitter.im/octokit/octokit.net NuGet NuGet

logo

Octokit is a client library targeting .NET Framework 4.6 or greater and .NET Standard 2.0 and above that provides an easy way to interact with the GitHub API.

Usage examples

Get public info on a specific user.

var github = new GitHubClient(new ProductHeaderValue("MyAmazingApp"));
var user = await github.User.Get("half-ogre");
Console.WriteLine(user.Followers + " folks love the half ogre!");

Supported Platforms

Getting Started

Octokit is a GitHub API client library for .NET and is available on NuGet:

dotnet add package Octokit

There is also an IObservable based GitHub API client library for .NET using Reactive Extensions:

dotnet add package Octokit.Reactive

Documentation

Documentation is available at http://octokitnet.readthedocs.io/en/latest/.

Build

Octokit is a single assembly designed to be easy to deploy anywhere.

To clone and build it locally click the "Clone in Desktop" button above or run the following git commands.

git clone git@github.com:octokit/Octokit.net.git Octokit
cd Octokit

To build the libraries, run the following command:

Windows: .\build.ps1

Linux/OSX: ./build.sh

Contribute

Visit the Contributor Guidelines for more details. All contributors are expected to follow our Code of Conduct.

Problems?

If you find an issue with our library, please visit the issue tracker and report the issue.

Please be kind and search to see if the issue is already logged before creating a new one. If you're pressed for time, log it anyways.

When creating an issue, clearly explain

  • What you were trying to do.
  • What you expected to happen.
  • What actually happened.
  • Steps to reproduce the problem.

Also include any other information you think is relevant to reproduce the problem.

Copyright and License

Copyright 2023 GitHub, Inc.

Licensed under the MIT License