Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/piecioshka/github-track-followers

:hammer: CLI to display followers of GitHub user
https://github.com/piecioshka/github-track-followers

cli github

Last synced: about 2 months ago
JSON representation

:hammer: CLI to display followers of GitHub user

Awesome Lists containing this project

README

        

# github-track-followers

[![npm version](https://badge.fury.io/js/github-track-followers.svg)](https://badge.fury.io/js/github-track-followers)
[![downloads count](https://img.shields.io/npm/dt/github-track-followers.svg)](https://www.npmjs.com/~piecioshka)

:hammer: CLI to display followers of GitHub user

## Installation

```bash
npm install -g github-track-followers
```

## Usage

```bash
github-track-followers -h

Usage: github-track-followers -u

CLI to display followers of GitHub user

Options:
-V, --version output the version number
-u, --user fetch and display followers from GitHub
-h, --help display help for command
```

## Examples

### :arrow_right: Use case: Display whole list of followers

```bash
github-track-followers -u piecioshka

GitHub user "piecioshka" has followers (268):

* a-dabrowski
* aarek
* adam-sokolowski
...
```

### :arrow_right: Use case: Save report to file

```bash
github-track-followers -u piecioshka > "/tmp/piecioshka-$(date +"%Y-%m-%d-%H-%M-%S").md"
```

```bash
cat /tmp/piecioshka-2016-11-18-22-47-52.md

GitHub user "piecioshka" has followers (268):

* a-dabrowski
* aarek
* adam-sokolowski
...
```

### :arrow_right: Use case: Enter to debug mode (eg. display requests)

```bash
DEBUG=* github-track-followers -u piecioshka
```

## Troubleshooting

ERROR: Try to display followers of user who is not exists

```bash
github-track-followers -u not-found-username-iu1h23j

Not found
```

_Solution_: maybe you have typo?

ERROR: Too many request in one day per one IP address

```bash
github-track-followers -u piecioshka

API rate limit exceeded for 999.999.999.999. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.)
```

_Solution_: you should rest though next 24 hours?

## License

[The MIT License](http://piecioshka.mit-license.org) @ 2016