Retrieves the running user's GitHub authentication token.
๐ช
## Usage
```shell
npm i get-github-auth-token
```
```ts
import { getGitHubAuthToken } from "get-github-auth-token";
const auth = await getGitHubAuthToken("Hello, world! ๐");
if (auth.succeeded) {
console.log("Token:", auth.token);
} else {
console.error("Oh no:", auth.error);
}
```
`getGitHubAuthToken` attempts to find a GitHub auth token from the following places, in order:
1. `process.env.GH_TOKEN`
2. `process.env.GITHUB_TOKEN`
3. Executing `gh auth token` as a child process
> ๐ก Using this to create a new [Octokit](https://octokit.github.io/rest.js) instance?
> See [JoshuaKGoldberg/octokit-from-auth](https://github.com/JoshuaKGoldberg/octokit-from-auth).
## Development
See [`.github/CONTRIBUTING.md`](./.github/CONTRIBUTING.md), then [`.github/DEVELOPMENT.md`](./.github/DEVELOPMENT.md).
Thanks! ๐ช
## Contributors
> ๐ This package was templated with [`create-typescript-app`](https://github.com/JoshuaKGoldberg/create-typescript-app) using the [Bingo framework](https://create.bingo).
---
_Source: https://npm.io/package/get-github-auth-token ยท Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
