kevva / github-search-repos

Search GitHub repositories

github-search-repos

Search GitHub repositories

Install

$ npm install --save github-search-repos

Usage

const githubSearchRepos = require('github-search-repos');

githubSearchRepos('gulp+language:javascript').then(data => {
	console.log(data.items);
	//=> [{id: 11167738, name: 'gulp', full_name: 'gulpjs/gulp', ...}, ...]
});

API

githubSearchRepos(query, [options])

query

Type: string

Search query.

options

token

Type: string

Token to authenticate with. Use this to increase the request count. Github supports up to 5 unauthenticated request per minute.

If you don't have a token you can generate a new one here.

sort

Type: string

Sort results by either stars , forks or updated. By default, results are sorted by best match.

Related

• github-search-repos-cli - CLI for this module

License

MIT © Kevin Mårtensson

github-search-repos's Issues

Support sorting

API and CLI should support selecting which sort order to use.

Interactive mode

Would be cool to have a interactive mode if the binary is run without arguments.

Like yo.

Where the user can search and be able to scroll up and down to see the results and hit enter to open it.

Maybe even keyboard shortcuts to change the sorting.