ghi

GitHub Info CLI

github-info is a command-line tool to retrieve information from GitHub repositories.

Installation

To install the github-info CLI, use the following command:

go install github.com/jbrinkman/ghi@latest

Usage

Retrieve Pull Requests

The pr command retrieves a list of pull requests from a specified GitHub repository.

Options

• --repo or -r: The name of the GitHub repository in the format owner/repo. This option is required.
• --author or -A: Filter pull requests by author. Multiple --author options can be used to provide a list of author filters. This option is optional.
• --state or -s: Filter pull requests by state. Valid values are ALL, OPEN, and CLOSED. The default value is ALL.
• --reviewer or -R: Filter pull requests by reviewer. Multiple --reviewer options can be used to provide a list of reviewer filters. This option is optional.
• --config or -c: Path to the configuration file in YAML format. This option is optional.

Example

Retrieve all pull requests from the octocat/Hello-World repository:

ghi pr --repo octocat/Hello-World

Retrieve pull requests from the octocat/Hello-World repository filtered by author octocat:

ghi pr --repo octocat/Hello-World --author octocat

Retrieve pull requests from the octocat/Hello-World repository filtered by multiple authors:

ghi pr --repo octocat/Hello-World --author octocat --author anotheruser

Retrieve pull requests from the octocat/Hello-World repository filtered by reviewer octocat:

ghi pr --repo octocat/Hello-World --reviewer octocat

Retrieve pull requests using a configuration file:

ghi pr --config path/to/config.yaml

View Pull Request Details

The view subcommand retrieves and displays details of a specific pull request from a specified GitHub repository.

Options

• --repo or -r: The name of the GitHub repository in the format owner/repo. This option is required.
• --number or -n: The number of the pull request. This option is required.
• --web or -w: Open the pull request in the default web browser. This option is optional.
• --config or -c: Path to the configuration file in YAML format. This option is optional.

Example

View details of pull request #2856 from the octocat/Hello-World repository:

ghi pr view --repo octocat/Hello-World --number 2856

View details of pull request #2856 from the octocat/Hello-World repository in the default web browser:

ghi pr view --repo octocat/Hello-World --number 2856 --web

Configuration File

You can use a YAML configuration file to specify the options for the pr command. Here is an example configuration file:

repo: "valkey-io/valkey-glide"
author:
  - "jbrinkman"
  - "Yury-Fridlyand"
  - "acarbonetto"
  - "jamesx-improving"
  - "jonathanl-bq"
  - "tjzhang-BQ"
  - "prateek-kumar-improving"
  - "cyip10"
  - "yipin-chen"
  - "edlng"
state: "open"
reviewer:
  - "jbrinkman"

Global Flags

Version Information

To check the version of the CLI tool:

ghi --version

This displays the current version, build date, and commit hash of your installation.