Awesome
octokit-auth-netrc
.netrc auth plugin for Octokit
<!--status-badges start --> <!--status-badges end -->Table of Contents
Usage
<!--consumer-badges start --> <!--consumer-badges end -->Installation
$ npm install octokit-auth-netrc --save-prod
Defining your token
Add a personal access token
to your ~/.netrc
file
machine api.github.com
login <personal access token here>
machine github.acme-inc.com
login <personal access token here>
Example
Import
import {createNetrcAuth} from './lib/index.cjs';
Authenticate
/*defaults to api.github.com*/
const auth = createNetrcAuth();
/*For use with GHES, override the default domain*/
const enterpriseAuth = createNetrcAuth({ domain: 'github.acme-inc.com' });
(async () => {
await auth();
await enterpriseAuth();
})();
API
createNetrcAuth
Returns an auth()
function
after reading your token from the ~/.netrc
file. Throws an error with code
ENONETRCTOKEN
when an entry for api.github.com
is not found in the
~/.netrc
file.
Contributing
<!--contribution-badges start --> <!--contribution-badges end -->Dependencies
$ nvm install
$ npm install
Verification
$ NODE_OPTIONS=--no-experimental-fetch npm test