get-github-user's Introduction

get-github-user

Get GitHub user information from just a username

Install

$ npm install --save get-github-user

You also need to get a GitHub application token: https://github.com/settings/tokens. Provide it in the CLI or set it as $GITHUB_TOKEN somewhere in your bash_profile.

Usage

const getGithubUser = require('get-github-user');

getGithubUser('RichardLitt');
//=> [{login: 'RichardLitt', ...}]

API

getGithubUser(input)

input

Type: string or array

The user or array of users you want user objects for.

token

Type: token

Send in your GitHub token.

endpoint

Type: string

Send in your GitHub Enterprise endpoint or rootURL.

CLI

$ npm install --global get-github-user

$ get-github-user --help

  Usage
    $ get-github-user [input]

  Options
    -t, --token A token
    -e, --endpoint Change the GitHub endpoint

  Examples
    $ get-github-user RichardLitt
    [{ login: 'RichardLitt',  ... }]
    $ get-github-user RichardLitt jbenet
    [{...}, {...}]

Contribute

Please do! Open an issue or a pull request if you see anything.

License

MIT © Richard Littauer

get-github-user's People

Contributors

Stargazers

Watchers

get-github-user's Issues

Meow v10 is a pure ESM module

This makes meow v10 no longer compatible with the cli, and causes it to fail.

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/.

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Once you have installed CI on this repository, you’ll need to re-trigger Greenkeeper’s initial Pull Request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper integration’s white list on Github. You'll find this list on your repo or organiszation’s settings page, under Installed GitHub Apps.