# github-org-repos

> Get meta data for all repositories belonging to an organization.

Latest version **1.0.2** (published 2016-03-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install github-org-repos
pnpm add github-org-repos
yarn add github-org-repos
bun add github-org-repos
```

Provides the commands `ghorgrepos`, `github-org-repos`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2016-03-07 |
| First published | 2016-02-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Athan Reines |
| Maintainers | kgryte |
| Keywords | github, git, gh, repos, repositories, meta, org, organization, get, fetch, retrieve, api, request, cli, utility, util |

## Links

- npm: https://www.npmjs.com/package/github-org-repos
- Repository: https://github.com/kgryte/github-org-repos
- Homepage: https://github.com/kgryte/github-org-repos#readme
- Issues: https://github.com/kgryte/github-org-repos/issues
- npm.io page: https://npm.io/package/github-org-repos

## Dependencies (7)

- [minimist](https://npm.io/package/minimist.md) ^1.2.0
- [utils-merge2](https://npm.io/package/utils-merge2.md) ^2.0.0
- [update-notifier](https://npm.io/package/update-notifier.md) ^0.6.0
- [@kgryte/github-get](https://npm.io/package/@kgryte/github-get.md) ^3.0.6
- [validate.io-object](https://npm.io/package/validate.io-object.md) ^1.0.4
- [validate.io-function](https://npm.io/package/validate.io-function.md) ^1.0.2
- [validate.io-string-primitive](https://npm.io/package/validate.io-string-primitive.md) ^1.0.0

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2016-03-07
- 1.0.1 — 2016-02-11
- 1.0.0 — 2016-02-11
- 0.0.0 — 2016-02-11

## README

Organization Repositories
===
[![NPM version][npm-image]][npm-url] [![Build Status][build-image]][build-url] [![Coverage Status][coverage-image]][coverage-url] [![Dependencies][dependencies-image]][dependencies-url]

> Get meta data for all [repositories][github-repos] belonging to an organization.


## Installation

``` bash
$ npm install github-org-repos
```


## Usage

``` javascript
var repos = require( 'github-org-repos' );
```

<a name="repos"></a>
#### repos( opts, clbk )

Gets meta data for all [repositories][github-repos] belonging to an organization.

``` javascript
var opts = {
	'org': 'math-io'
};

repos( opts, clbk );

function clbk( error, results, info ) {
	// Check for rate limit information...
	if ( info ) {
		console.error( 'Limit: %d', info.limit );
		console.error( 'Remaining: %d', info.remaining );
		console.error( 'Reset: %s', (new Date( info.reset*1000 )).toISOString() );
	}
	if ( error ) {
		throw new Error( error.message );
	}
	console.log( JSON.stringify( results ) );
	// returns <repo_data>
}
```

The `function` accepts the following `options`:
*	__org__: Github organization name (*required*).
* 	__type__: repository [type][github-org-repos]; e.g., `forks`, `public`, `private`, etc. Default: `'all'`.
*	__token__: Github [access token][github-token].
*	__useragent__: [user agent][github-user-agent] `string`.

To [authenticate][github-oauth2] with Github, set the [`token`][github-token] option.

``` javascript
var opts = {
	'org': 'math-io',
	'token': 'tkjorjk34ek3nj4!'
};

repos( opts, clbk );
```

To specify a [user agent][github-user-agent], set the `useragent` option.

``` javascript
var opts = {
	'org': 'math-io',
	'useragent': 'hello-github!'
};

repos( opts, clbk );
```

To return repositories of a particular [type][github-org-repos], set the `type` option.

``` javascript
var opts = {
	'org': 'math-io',
	'type': 'forks'
};

repos( opts, clbk );
```


#### repos.factory( options, clbk )

Creates a reusable `function`.

``` javascript
var opts = {
	'org': 'math-io',
	'token': 'tkjorjk34ek3nj4!'
};

var get = repos.factory( opts, clbk );

get();
get();
get();
// ...
```

The factory method accepts the same `options` as [`repos()`](#repos).


## Notes

*	[Rate limit][github-rate-limit] information includes the following:
	-	__limit__: maximum number of requests a consumer is permitted to make per hour.
	-	__remaining__: number of remaining requests.
	-	__reset__: time at which the current [rate limit][github-rate-limit] window resets in [UTC seconds][unix-time].


---
## Examples

``` javascript
var repos = require( 'github-org-repos' );

var opts = {
	'org': 'math-io',
	'useragent': 'beep-boop-bop'
};

repos( opts, clbk );

function clbk( error, results, info ) {
	if ( info ) {
		console.error( info );
	}
	if ( error ) {
		throw new Error( error.message );
	}
	console.log( results );
}
```

To run the example code from the top-level application directory,

``` bash
$ DEBUG=* node ./examples/index.js
```


---
## CLI

### Installation

To use the module as a general utility, install the module globally

``` bash
$ npm install -g github-org-repos
```


### Usage

``` bash
Usage: ghorgrepos [options] (--org org | org)

Options:

  -h,  --help               Print this message.
  -V,  --version            Print the package version.
       --token token        Github access token.
       --org org            Github organization name.
  -ua, --useragent ua       User agent.
       --type type          Repository type; e.g., forks, public, private, etc.
```


### Notes

*	In addition to the [`token`][github-token] option, the [token][github-token] may also be specified by a [`GITHUB_TOKEN`][github-token] environment variable. The command-line option __always__ takes precedence.
*	Request resources are written to `stdout`.
*	[Rate limit][github-rate-limit] information is written to `stderr`.


### Examples

Setting the access [token][github-token] using the command-line option:

``` bash
$ DEBUG=* ghorgrepos --token <token> --org 'math-io'
# => '[{...},{...},...]'
```

Setting the access [token][github-token] using an environment variable:

``` bash
$ DEBUG=* GITHUB_TOKEN=<token> ghorgrepos --org 'math-io'
# => '[{...},{...},...]'
```

For local installations, modify the command to point to the local installation directory; e.g., 

``` bash
$ DEBUG=* ./node_modules/.bin/ghorgrepos --token <token> --org 'math-io'
# => '[{...},{...},...]'
```

Or, if you have cloned this repository and run `npm install`, modify the command to point to the executable; e.g., 

``` bash
$ DEBUG=* node ./bin/cli --token <token> --org 'math-io'
# => '[{...},{...},...]'
```


---
## Tests

### Unit

This repository uses [tape][tape] for unit tests. To run the tests, execute the following command in the top-level application directory:

``` bash
$ make test
```

All new feature development should have corresponding unit tests to validate correct functionality.


### Test Coverage

This repository uses [Istanbul][istanbul] as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

``` bash
$ make test-cov
```

Istanbul creates a `./reports/coverage` directory. To access an HTML version of the report,

``` bash
$ make view-cov
```


### Browser Support

This repository uses [Testling][testling] for browser testing. To run the tests in a (headless) local web browser, execute the following command in the top-level application directory:

``` bash
$ make test-browsers
```

To view the tests in a local web browser,

``` bash
$ make view-browser-tests
```

<!-- [![browser support][browsers-image]][browsers-url] -->


---
## License

[MIT license](http://opensource.org/licenses/MIT).


## Copyright

Copyright &copy; 2016. Athan Reines.


[npm-image]: http://img.shields.io/npm/v/github-org-repos.svg
[npm-url]: https://npmjs.org/package/github-org-repos

[build-image]: http://img.shields.io/travis/kgryte/github-org-repos/master.svg
[build-url]: https://travis-ci.org/kgryte/github-org-repos

[coverage-image]: https://img.shields.io/codecov/c/github/kgryte/github-org-repos/master.svg
[coverage-url]: https://codecov.io/github/kgryte/github-org-repos?branch=master

[dependencies-image]: http://img.shields.io/david/kgryte/github-org-repos.svg
[dependencies-url]: https://david-dm.org/kgryte/github-org-repos

[dev-dependencies-image]: http://img.shields.io/david/dev/kgryte/github-org-repos.svg
[dev-dependencies-url]: https://david-dm.org/dev/kgryte/github-org-repos

[github-issues-image]: http://img.shields.io/github/issues/kgryte/github-org-repos.svg
[github-issues-url]: https://github.com/kgryte/github-org-repos/issues

[tape]: https://github.com/substack/tape
[istanbul]: https://github.com/gotwarlost/istanbul
[testling]: https://ci.testling.com

[unix-time]: http://en.wikipedia.org/wiki/Unix_time

[github-get]: https://github.com/kgryte/github-get
[github-repos]: https://developer.github.com/v3/repos/
[github-org-repos]: https://developer.github.com/v3/repos/#list-organization-repositories
[github-api]: https://developer.github.com/v3/
[github-token]: https://github.com/settings/tokens/new
[github-oauth2]: https://developer.github.com/v3/#oauth2-token-sent-in-a-header
[github-user-agent]: https://developer.github.com/v3/#user-agent-required
[github-rate-limit]: https://developer.github.com/v3/rate_limit/

---
_Source: https://npm.io/package/github-org-repos · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._