3.1.1 • Published 2 months ago
octokit-auth-netrc v3.1.1
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>
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
Dependencies
$ nvm install
$ npm install
Verification
$ NODE_OPTIONS=--no-experimental-fetch npm test
3.1.1
2 months ago
3.1.0
5 months ago
3.0.0-beta.1
6 months ago
3.0.0-beta.3
6 months ago
3.0.0-beta.2
6 months ago
3.0.0
6 months ago
2.1.0
1 year ago
2.0.1
2 years ago
2.0.0
2 years ago
1.0.1
3 years ago
1.0.0
4 years ago
1.0.0-alpha.2
4 years ago
1.0.0-alpha.1
4 years ago