$ ghcal

See the GitHub contributions calendar of a user in the command line.

If you want to track all your git commits (even if you don't push them anywhere), you should check out the git-stats project.

Installation

You can install the package globally and use it as command line tool:

$ npm i -g ghcal

Then, run ghcal --help and see what the CLI tool can do.

$ ghcal --help
Usage: ghcal [options]

Options:
  -u, --username <username>  The GitHub username. If you're using CLI GitHub,
                             by default it will be your username.            
  -c, --cookie <cookie>      Your GitHub cookie. Useful to get private stats.
  -s, --since <date>         Optional start date.                            
  -e, --until <date>         Optional end date.                              
  -n, --no-ansi              Forces the tool not to use ANSI styles.         
  -l, --light                Enables the light theme.                        
  -h, --help                 Displays this help.                             
  -v, --version              Displays version information.                   

Examples:
  ghcal -u ionicabizau
  ghcal -u ionicabizau --light
  ghcal -u ionicabizau --no-ansi
  ghcal -u ionicabizau -s '1 January 2015' # All the commits from 1 January 2015 to now
  ghcal -u ionicabizau -s '1 January 2015' -e '1 March 2015' # Select a time range

Note that only the last year statistics are available.

Documentation can be found at https://github.com/IonicaBizau/ghcal

Usage

Default behavior

If you are already using cli-github, then your GitHub username is kept into ~/.github-config.json and ghcal will use it if you don't pass another username: ghcal will be the same with ghcal -u <your-username>.

ghcal

Passing the username

sing the -u (or --username) option, you can specify the GitHub username:

# Fetches the izuzak's contributions
$ ghcal -u izuzak

Themes

If you pass the --light option, then the light theme will be activated (the default theme is dark).

# jlord's contributions, light theme
$ ghcal jlord --light

No ANSI styles

The --no-ansi option disables any colors in the output. Unicode characters, without colors will be used.

# @pengywynn's contributions, but without ANSI styles
$ ghcal pengwynn --no-ansi

Example

Here is an example how to use this package as library. To install it locally, as library, you can do that using npm:

$ npm i --save ghcal

var GhCal = require("ghcal");

GhCal("ionicabizau", function (err, data) {
    console.log(err || data);
});

Documentation

For full API reference, see the DOCUMENTATION.md file.

How to contribute

Have an idea? Found a bug? See how to contribute.

Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

• github-stats

License

MIT © Ionică Bizău