0.3.1 • Published 10 years ago

ask-for-github-auth v0.3.1

Weekly downloads
6
License
MIT
Repository
github
Last release
10 years ago

ask-for-github-auth NPM version Build Status

Prompt a user for their github authentication credentials and save the results.

Install with npm

$ npm i ask-for-github-auth --save

Usage

var ask = require('ask-for-github-auth');

API

askForGithubAuth

Prompt a user for their github authentication credentials. Save the answer so they're only asked once.

Params

  • options {Object}: Options to pass to ask-once
  • options.store {String}: a data-store instance or name that can be passed to ask-once
  • cb {Function}: Callback function returning either an error or authentication credentials

Example

ask(function (err, creds) {
  console.log(creds);
  //=>    {type: 'oauth', token: '123456'}
  //=> or {type: 'basic', username: 'doowb', password: 'password'}
});

Related projects

  • ask-once: Only ask a question one time and store the answer.
  • data-store: Easily get, set and persist config data.
  • inquirer: A collection of common interactive command line user interfaces.
  • question-cache: A wrapper around inquirer that makes it easy to create and selectively reuse questions.

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Brian Woodward

License

Copyright © 2015 Brian Woodward Released under the MIT license.


This file was generated by verb-cli on August 20, 2015.

0.3.1

10 years ago

0.3.0

10 years ago

0.2.0

10 years ago

0.1.4

10 years ago

0.1.3

10 years ago

0.1.2

10 years ago

0.1.1

10 years ago

0.1.0

10 years ago