Creates a GitHub Octokit instance from any available auth token.
๐
## Usage
```shell
npm i octokit-from-auth
```
Two functions are exported by the `octokit-from-auth` package.
Both are asynchronous and take in the same constructor parameters as the [`Octokit` class](https://github.com/octokit/octokit.js?tab=readme-ov-file#octokit-api-client):
- `octokitFromAuth`: rejects if an auth token isn't provided and can't be resolved by [`get-github-auth-token`](https://github.com/JoshuaKGoldberg/get-github-auth-token)
- `octokitFromAuthSafe`: resolves an `Octokit` with no authentication if an auth token isn't provided and can't be resolved by [`get-github-auth-token`](https://github.com/JoshuaKGoldberg/get-github-auth-token)
Both return a new Octokit instance.
```ts
import { octokitFromAuth } from "octokit-from-auth";
// auth token used:
// process.env.GH_TOKEN ?? (await $`gh auth token`)
await octokitFromAuth();
```
The Octokit's `auth` is retrieved with [`get-github-auth-token`](https://github.com/JoshuaKGoldberg/get-github-auth-token), which defaults to `process.env.GH_TOKEN`, or failing that, [`gh auth token`](https://cli.github.com/manual/gh_auth_token).
If neither is available then an auth token must be provided as an option:
```ts
import { octokitFromAuth } from "octokit-from-auth";
// auth token used:
// "gho_..."
await octokitFromAuth({ auth: "gho_..." });
```
## 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/octokit-from-auth ยท Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
