Skip to content

Latest commit

 

History

History
118 lines (98 loc) · 4.85 KB

README.md

File metadata and controls

118 lines (98 loc) · 4.85 KB
Raw

coco

track project stats

Usage

$ go get -u github.com/g-harel/coco

Usage: coco [flags...]

Flags:
  -github-new-stars int
        Show repos if they have this quantity of new stars (default 1)
  -github-owner value
        GitHub owner to query.
  -github-stars int
        Show repos if they have this quantity of stars. (default 1)
  -github-today int
        Show repos if they have this quantity of views today. (default 1)
  -github-token string
        GitHub API token.
  -github-views int
        Show repos if they have this quantity of views. (default 1)
  -log-error
        Log errors. (default true)
  -log-info
        Log miscellaneous info.
  -npm-owner value
        NPM owners whose packages to query.
  -npm-weekly int
        Show repos if they have this quantity of weekly downloads. (default 1)
  -rate-limit int
        Maximum number of requests per second by all collectors. (default 999)
  -state-file string
        Absolute path to file used to store state between runs.

GitHub traffic can only be collected from repositories that the token grants push access to.

Quantity of new stars can only be accurately shown if a state file is provided.

A single run can collect data from both GitHub and NPM.

Examples

GitHub

coco -github-token=<token> -github-owner=<owner>

Tokens can be generated by following the steps in the documentation.

Organization names can also be passed in as owners to query.

NPM

coco -npm-owner=<owner>

Mixed

coco \
    -log-info \
    -rate-limit=42 \
    -state-file="/home/me/.coco" \
    -github-token=<token> \
    -github-owner=<user> \
    -github-owner=<org> \
    -github-views=4 \
    -github-today=1 \
    -github-stars=3 \
    -npm-owner=<user> \
    -npm-weekly=12
+----------------------------------+
| GitHub repo stats | <user> <org> |
+--------------------------+-------+--------+-------+------------------------------------------------------------------+
| REPO                     | VIEWS | UNIQUE | TODAY | LINK                                                             |
+--------------------------+-------+--------+-------+------------------------------------------------------------------+
| blobs+34                 |   131 |     18 |     0 | https://github.com/g-harel/blobs/graphs/traffic                  |
| npmfs+83                 |    19 |     10 |     0 | https://github.com/g-harel/npmfs/graphs/traffic                  |
| superpermutations+1      |    16 |      6 |     3 | https://github.com/g-harel/superpermutations/graphs/traffic      |
| SOEN321+0                |    10 |      3 |     0 | https://github.com/g-harel/SOEN321/graphs/traffic                |
| coco+2                   |     7 |      3 |     1 | https://github.com/g-harel/coco/graphs/traffic                   |
| targetblank+5            |     7 |      3 |     0 | https://github.com/g-harel/targetblank/graphs/traffic            |
| rickety+9                |     5 |      5 |     1 | https://github.com/g-harel/rickety/graphs/traffic                |
| okwolo+21                |     5 |      3 |     0 | https://github.com/okwolo/okwolo/graphs/traffic                  |
| cards-amusing-humanity+1 |     4 |      2 |     0 | https://github.com/g-harel/cards-amusing-humanity/graphs/traffic |
| svgsaurus+6              |     3 |      3 |     0 | https://github.com/g-harel/svgsaurus/graphs/traffic              |
| sekstant+56              |     2 |      2 |     0 | https://github.com/g-harel/sekstant/graphs/traffic               |
| website+10               |     2 |      2 |     0 | https://github.com/g-harel/website/graphs/traffic                |
| ence+8                   |     0 |      0 |     0 | https://github.com/g-harel/ence/graphs/traffic                   |
| open-source-logos+3      |     0 |      0 |     0 | https://github.com/g-harel/open-source-logos/graphs/traffic      |
| slurry+5                 |     0 |      0 |     0 | https://github.com/g-harel/slurry/graphs/traffic                 |
+--------------------------+-------+--------+-------+------------------------------------------------------------------+
+--------------------------------+
| Npm package downloads | <user> |
+---------+-----------+-------+-----------------------------------+
| PACKAGE | DOWNLOADS | TOTAL | LINK                              |
+---------+-----------+-------+-----------------------------------+
| blobs   |       305 | 7,111 | https://npmjs.com/package/blobs   |
| paph    |        20 |   339 | https://npmjs.com/package/paph    |
| okwolo  |        19 | 1,863 | https://npmjs.com/package/okwolo  |
| rickety |        12 | 1,289 | https://npmjs.com/package/rickety |
+---------+-----------+-------+-----------------------------------+

License

MIT