octokit-auth-netrc

octokit-auth-netrc

netrc auth plugin for Octokit

Table of Contents

• Usage
  • Installation
  • Example
    • Import
    • Authenticate
  • API
    • createNetrcAuth
    • auth()
    • Authentication object
• Contributing
  • Dependencies
  • Verification

Usage

Installation

$ npm install octokit-auth-netrc --save-prod

Example

Import

import {createNetrcAuth} from 'octokit-auth-netrc';

  [`${process.env.HOME}/.netrc`]: `
machine api.github.com
  login asdflkajsdflkjadlfjalsdkfjalsdfja
`
});

Authenticate

const auth = createNetrcAuth();

(async () => {
  await auth();
})();

API

createNetrcAuth

returns an object with an auth() method

auth()

The auth() method has no options. It returns a promise which resolves with the authentication object.

Authentication object

name	type	description
type	string	"token"
token	string	The provided token.

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test