knitr::opts_chunk$set( collapse = TRUE, comment = "#>", fig.path = "man/figures/README-", out.width = "100%" )
Minimalistic client to access GitHub's REST and GraphQL APIs.
Install the package from CRAN as usual:
install.packages("gh")
Install the development version from GitHub:
pak::pak("r-lib/gh")
The value returned by gh::gh_token()
is used as Personal Access Token
(PAT). A token is needed for some requests, and to help with rate limiting.
gh can use your regular git credentials in the git credential store, via
the gitcreds package. Use gitcreds::gitcreds_set()
to put a PAT into the
git credential store. If you cannot use the credential store, set the
GITHUB_PAT
environment variable to your PAT. See the details in the
?gh::gh_token
manual page and the manual of the gitcreds package.
GITHUB_API_URL
environment variable, if set, is used for the default github api url.library(gh)
Use the gh()
function to access all API endpoints. The endpoints are
listed in the documentation.
The first argument of gh()
is the endpoint. You can just copy and paste the
API endpoints from the documentation. Note that the leading slash
must be included as well.
From https://docs.github.com/rest/reference/repos#list-repositories-for-a-user you can copy and paste GET /users/{username}/repos
into your gh()
call. E.g.
my_repos <- gh("GET /users/{username}/repos", username = "gaborcsardi") vapply(my_repos, "[[", "", "name")
The JSON result sent by the API is converted to an R object.
Parameters can be passed as extra arguments. E.g.
my_repos <- gh( "/users/{username}/repos", username = "gaborcsardi", sort = "created") vapply(my_repos, "[[", "", "name")
POST, PATCH, PUT, and DELETE requests can be sent by including the HTTP verb before the endpoint, in the first argument. E.g. to create a repository:
new_repo <- gh("POST /user/repos", name = "my-new-repo-for-gh-testing")
and then delete it:
gh("DELETE /repos/{owner}/{repo}", owner = "gaborcsardi", repo = "my-new-repo-for-gh-testing")
By default the GITHUB_PAT
environment variable is used. Alternatively,
one can set the .token
argument of gh()
.
Supply the page
parameter to get subsequent pages:
my_repos2 <- gh("GET /orgs/{org}/repos", org = "r-lib", page = 2) vapply(my_repos2, "[[", "", "name")
GITHUB_API_URL
environment variable is used for the default github
api url.GITHUB_PAT
and GITHUB_TOKEN
environment variables are used, if
set, in this order, as default token. Consider using the git credential
store instead, see ?gh::gh_token
.Please note that the gh project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.
MIT © Gábor Csárdi, Jennifer Bryan, Hadley Wickham
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.