Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/IonicaBizau/ghcal
:calendar: See the GitHub contributions calendar of a user in the command line.
https://github.com/IonicaBizau/ghcal
hacktoberfest
Last synced: about 2 months ago
JSON representation
:calendar: See the GitHub contributions calendar of a user in the command line.
- Host: GitHub
- URL: https://github.com/IonicaBizau/ghcal
- Owner: IonicaBizau
- License: mit
- Created: 2015-02-09T12:08:41.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-08-09T11:27:13.000Z (about 4 years ago)
- Last Synced: 2024-05-22T22:30:22.241Z (4 months ago)
- Topics: hacktoberfest
- Language: JavaScript
- Homepage:
- Size: 43 KB
- Stars: 192
- Watchers: 10
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](#)
# `$ ghcal`
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://www.npmjs.com/package/ghcal) [](https://www.npmjs.com/package/ghcal) [](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
> 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](https://github.com/IonicaBizau/git-stats).
[](#)
## :cloud: Installation
You can install the package globally and use it as command line tool:
```sh
# Using npm
npm install --global ghcal
# Using yarn
yarn global add ghcal
```
Then, run `ghcal --help` and see what the CLI tool can do.
```
$ ghcal --help
Usage: ghcal [options]
Options:
-u, --username The GitHub username. If you're using CLI GitHub,
by default it will be your username.
-c, --cookie Your GitHub cookie. Useful to get private stats.
-s, --since Optional start date.
-e, --until 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`](https://github.com/IonicaBizau/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 `.
```sh
ghcal
```
### Passing the username
Using the `-u` (or `--username`) option, you can specify the GitHub username:
```sh
# 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).
```sh
# 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.
```sh
# @pengywynn's contributions, but without ANSI styles
$ ghcal pengwynn --no-ansi
```
## :clipboard: Example
Here is an example how to use this package as library. To install it locally, as library, you can use `npm install ghcal` (or `yarn add ghcal`):
```js
var GhCal = require("ghcal");
GhCal("ionicabizau", function (err, data) {
console.log(err || data);
});
```
## :question: Get Help
There are few ways to get help:
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
## :memo: Documentation
For full API reference, see the [DOCUMENTATION.md][docs] file.
## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].
## :sparkling_heart: Support my projects
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
- Starring and sharing the projects you like :rocket:
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
- **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
Thanks! :heart:
## :dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:
- `github-stats`
## :scroll: License
[MIT][license] © [Ionică Bizău][website]
[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW