Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/IonicaBizau/cli-gh-cal
:chart_with_upwards_trend: GitHub like calendar graphs in command line.
https://github.com/IonicaBizau/cli-gh-cal
hacktoberfest
Last synced: 3 months ago
JSON representation
:chart_with_upwards_trend: GitHub like calendar graphs in command line.
- Host: GitHub
- URL: https://github.com/IonicaBizau/cli-gh-cal
- Owner: IonicaBizau
- License: mit
- Created: 2015-07-08T06:54:51.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-08-09T10:10:48.000Z (over 4 years ago)
- Last Synced: 2024-07-21T07:24:55.837Z (4 months ago)
- Topics: hacktoberfest
- Language: JavaScript
- Homepage:
- Size: 40 KB
- Stars: 36
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](#)
# `$ cli-gh-cal`
[![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://travis-ci.org/IonicaBizau/cli-gh-cal/) [](https://www.npmjs.com/package/cli-gh-cal) [](https://www.npmjs.com/package/cli-gh-cal) [](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
> GitHub like calendar graphs in command line.
[](#)
## :cloud: Installation
You can install the package globally and use it as command line tool:
```sh
# Using npm
npm install --global cli-gh-cal
# Using yarn
yarn global add cli-gh-cal
```
Then, run `cli-gh-cal --help` and see what the CLI tool can do.
```
$ cli-gh-cal --help
Usage: cli-gh-cal [options]
GitHub like calendar graphs in command line.
Options:
--raw Get raw data.
-l, --light Enables the light theme.
-n, --no-ansi Forces the tool not to use ANSI styles.
-e, --end The end date.
-s, --start The start date.
-t, --theme The theme to use.
-d, --data Provide the JSON data in this format:
[["03/14/2015", 5]]
-h, --help Displays this help.
-v, --version Displays version information.
Examples:
$ cli-gh-cal -d '[["03/14/2015", 5]]' -t none
$ cli-gh-cal -d '[["03/14/2015", 5]]' -s '1 January 2014'
Documentation can be found at https://github.com/IonicaBizau/cli-gh-cal.
```
## :clipboard: Example
Here is an example how to use this package as library. To install it locally, as library, you can use `npm install cli-gh-cal` (or `yarn add cli-gh-cal`):
```js
// Dependencies
var CliGhCal = require("cli-gh-cal")
, Moment = require("moment")
;
console.log(CliGhCal([
[Moment().format("LL"), 4]
, [Moment().subtract(2, "days").format("LL"), 6]
], {
theme: "LIGHT"
, start: new Moment().subtract(1, "years")
, end: new Moment()
}));
```
## :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:
- `git-stats`
- `ghcal`
- `git-scene`
- `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