README
octokit-auth-netrc
.netrc auth plugin for Octokit
Table of Contents
Usage
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>
Example
Import
import {createNetrcAuth} from 'octokit-auth-netrc';
Authenticate
const auth = createNetrcAuth();
(async () => {
await auth();
})();
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
Dependencies
$ nvm install
$ npm install
Verification
$ npm test