gh api

Make an authenticated GitHub API request

Synopsis

Makes an authenticated HTTP request to the GitHub API and prints the response.

The endpoint argument should either be a path of a GitHub API v3 endpoint, or “graphql” to access the GitHub API v4.

Placeholder values “:owner” and “:repo” in the endpoint argument will get replaced with values from the repository of the current directory.

The default HTTP request method is “GET” normally and “POST” if any parameters were added. Override the method with ‘–method’.

Pass one or more ‘–raw-field’ values in “key=value” format to add JSON-encoded string parameters to the POST body.

The ‘–field’ flag behaves like ‘–raw-field’ with magic type conversion based on the format of the value:

Raw request body may be passed from the outside via a file specified by ‘–input’. Pass “-“ to read from standard input. In this mode, parameters specified via ‘–field’ flags are serialized into URL query parameters.

In ‘–paginate’ mode, all pages of results will sequentially be requested until there are no more pages of results. For GraphQL requests, this requires that the original query accepts an ‘$endCursor: String’ variable and that it fetches the ‘pageInfo{ hasNextPage, endCursor }’ set of fields from a collection.

gh api <endpoint> [flags]

Examples

$ gh api repos/:owner/:repo/releases

$ gh api graphql -F owner=':owner' -F name=':repo' -f query='
	query($name: String!, $owner: String!) {
		repository(owner: $owner, name: $name) {
			releases(last: 3) {
				nodes { tagName }
			}
		}
	}
'

$ gh api graphql --paginate -f query='
	query($endCursor: String) {
		viewer {
			repositories(first: 100, after: $endCursor) {
				nodes { nameWithOwner }
				pageInfo {
					hasNextPage
					endCursor
				}
			}
		}
	}
'

Options

  -F, --field stringArray       Add a parameter of inferred type
  -H, --header stringArray      Add an additional HTTP request header
  -i, --include                 Include HTTP response headers in the output
      --input string            The file to use as body for the HTTP request
  -X, --method string           The HTTP method for the request (default "GET")
      --paginate                Make additional HTTP requests to fetch all pages of results
  -f, --raw-field stringArray   Add a string parameter

Options inherited from parent commands

      --help              Show help for command
  -R, --repo OWNER/REPO   Select another repository using the OWNER/REPO format