octokit.rb

# Octokit

> **Note**
> We've recently renamed the `4-stable` branch to `main`. This might affect you if you're making changes to Octokit's code locally. For more details and for the steps to reconfigure your local clone for the new branch name, check out [this post](https://github.com/octokit/octokit.rb/discussions/1455).

Ruby toolkit for the GitHub API.

![logo](https://docs.github.com/assets/images/gundamcat.png)

Upgrading? Check the [Upgrade Guide](#upgrading-guide) before bumping to a new
[major version][semver].

## Table of Contents

1. [Philosophy](#philosophy)
2. [Installation](#installation)
3. [Making requests](#making-requests)
   1. [Additional Query Parameters](#additional-query-parameters)
4. [Consuming resources](#consuming-resources)
5. [Accessing HTTP responses](#accessing-http-responses)
6. [Handling errors](#handling-errors)
7. [Authentication](#authentication)
   1. [Basic Authentication](#basic-authentication)
   2. [OAuth access tokens](#oauth-access-tokens)
   3. [Two-Factor Authentication](#two-factor-authentication)
   4. [Using a .netrc file](#using-a-netrc-file)
   5. [Application authentication](#application-authentication)
   6. [GitHub App](#github-app)
8. [Default results per_page](#default-results-per_page)
9. [Pagination](#pagination)
   1. [Auto pagination](#auto-pagination)
10. [Working with GitHub Enterprise](#working-with-github-enterprise)
   1. [Interacting with the GitHub.com APIs in GitHub Enterprise](#interacting-with-the-githubcom-apis-in-github-enterprise)
   2. [Interacting with the GitHub Enterprise Admin APIs](#interacting-with-the-github-enterprise-admin-apis)
   3. [Interacting with the GHES Manage API](#interacting-with-the-ghes-manage-api)
   4. [SSL Connection Errors](#ssl-connection-errors)
11. [Configuration and defaults](#configuration-and-defaults)
    1. [Configuring module defaults](#configuring-module-defaults)
    2. [Using ENV variables](#using-env-variables)
    3. [Timeouts](#timeouts)
12. [Hypermedia agent](#hypermedia-agent)
    1. [Hypermedia in Octokit](#hypermedia-in-octokit)
    2. [URI templates](#uri-templates)
    3. [The Full Hypermedia Experience™](#the-full-hypermedia-experience)
13. [Upgrading guide](#upgrading-guide)
    1. [Upgrading from 1.x.x](#upgrading-from-1xx)
14. [Advanced usage](#advanced-usage)
    1. [Debugging](#debugging)
    2. [Caching](#caching)
15. [Hacking on Octokit.rb](#hacking-on-octokitrb)
    1. [Code of Conduct](#code-of-conduct)
    2. [Running and writing new tests](#running-and-writing-new-tests)
16. [Supported Ruby Versions](#supported-ruby-versions)
17. [Versioning](#versioning)
18. [Making Repeating Requests](#making-repeating-requests)
19. [License](#license)

## Philosophy

API wrappers [should reflect the idioms of the language in which they were
written][wrappers]. Octokit.rb wraps the [GitHub API][github-api] in a flat API
client that follows Ruby conventions and requires little knowledge of REST.
Most methods have positional argumen