Info on current GitHub user and token
Reports wallet name, GitHub login, and GitHub URL for the current authenticated user, the first bit of the token, and the associated scopes.
gh_whoami(.token = NULL, .api_url = NULL, .send_headers = NULL)
.token |
Authentication token. Defaults to |
.api_url |
Github API url (default: https://api.github.com). Used
if |
.send_headers |
Named character vector of header field values
(except |
Get a personal access token for the GitHub API from
https://github.com/settings/tokens and select the scopes necessary for your
planned tasks. The repo scope, for example, is one many are likely to need.
On macOS and Windows it is best to store the token in the git credential store, where most GitHub clients, including gh, can access it. You can use the gitcreds package to add your token to the credential store:
gitcreds::gitcreds_set()
See https://gh.r-lib.org/articles/managing-personal-access-tokens.html and https://usethis.r-lib.org/articles/articles/git-credentials.html for more about managing GitHub (and generic git) credentials.
On other systems, including Linux, the git credential store is
typically not as convenient, and you might want to store your token in
the GITHUB_PAT environment variable, which you can set in your
.Renviron file.
A gh_response object, which is also a list.
gh_whoami()
## explicit token + use with GitHub Enterprise
gh_whoami(.token = "8c70fd8419398999c9ac5bacf3192882193cadf2",
.api_url = "https://github.foobar.edu/api/v3")Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.