get-github-auth-token

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. Executing gh auth token as a child process

> 💡 Using this to create a new Octokit instance?
> See JoshuaKGoldberg/octokit-from-auth.

Development

See .github/CONTRIBUTING.md, then .github/DEVELOPMENT.md.
Thanks! 🪙

Contributors

Josh Goldberg ✨ 💻 🖋 📖 🤔 🚇 🚧 📆 🔧 🐛

> 💝 This package was templated with create-typescript-app` using the Bingo engine.