⚡ Github release analytics for the console
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

readme.md

Rels

⚡ Github release analytics for the console

Build Status

Description

By utilizing a simple and minimal usage syntax rels enables you to easily view various analytics & stats regarding the releases of any GitHub repository, displayed in a clean & concise manner, right from within your terminal.

Visit the contributing guidelines to learn more on how to translate this document into more languages.

Come over to Twitter to share your thoughts on the project.

Highlights

  • Overall release analytics
  • Clean & concise output
  • Simple & minimal usage syntax
  • Update notifications

Contents

Install

NPM

npm install --global rels

Snapcraft

snap install rels

Usage

  Usage
    $ rels [<options> ...]

    Options
      --repo, -r         Repository to get analytics for
      --list, -l         Number of releases to be displayed
      --all, -a          Display all releases
      --help, -h         Display help message
      --version, -v      Display installed version

    Examples
      $ rels --repo klaussinani/tusk
      $ rels --repo klaussinani/tusk --all
      $ rels --repo klaussinani/tusk --list 3

Development

For more info on how to contribute to the project, please read the contributing guidelines.

  • Fork the repository and clone it to your machine
  • Navigate to your local fork: cd rels
  • Install the project dependencies: npm install or yarn install
  • Lint the code for errors: npm test or yarn test

Related

  • signale - Hackable console logger

Team

License

MIT