Skip to content

Latest commit

 

History

History
 
 

github-username

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

readme.md

github-username Build Status

Get a GitHub username from an email address

Only works for users that have their email publicly listed on their profile.

Install

$ npm install --save github-username

Usage

var githubUsername = require('github-username');

githubUsername('sindresorhus@gmail.com', function (err, username) {
	console.log(username);
	//=> 'sindresorhus'
});

API

githubUsername(email, [token], callback)

email

Required
Type: string

Email address for the user of whom you want the username.

token

Type: string

GitHub personal access token.

callback(err, username)

CLI

$ npm install --global github-username
$ github-username --help

  Usage
    github-username <email> [--token OAUTH-TOKEN]
    echo <email> | github-username

  Example
    github-username sindresorhus@gmail.com
    sindresorhus

License

MIT © Sindre Sorhus