{"id":13746978,"url":"https://github.com/IonicaBizau/ghcal","last_synced_at":"2025-05-09T08:30:56.227Z","repository":{"id":66024612,"uuid":"30534032","full_name":"IonicaBizau/ghcal","owner":"IonicaBizau","description":":calendar: See the GitHub contributions calendar of a user in the command line.","archived":false,"fork":false,"pushed_at":"2020-08-09T11:27:13.000Z","size":44,"stargazers_count":192,"open_issues_count":1,"forks_count":11,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-05-22T22:30:22.241Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IonicaBizau.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2015-02-09T12:08:41.000Z","updated_at":"2024-02-06T19:06:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"4db25356-7213-42bb-ab1d-803f82eeab77","html_url":"https://github.com/IonicaBizau/ghcal","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IonicaBizau%2Fghcal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IonicaBizau%2Fghcal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IonicaBizau%2Fghcal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IonicaBizau%2Fghcal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IonicaBizau","download_url":"https://codeload.github.com/IonicaBizau/ghcal/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224838317,"owners_count":17378265,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest"],"created_at":"2024-08-03T06:01:09.160Z","updated_at":"2025-05-09T08:30:56.205Z","avatar_url":"https://github.com/IonicaBizau.png","language":"JavaScript","funding_links":["https://www.buymeacoffee.com/H96WwChMy","https://www.patreon.com/ionicabizau","https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=RVXDDLKKLQRJW"],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003c!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. --\u003e\n\n\n\n\n\n\n\n\n[![ghcal](http://i.imgur.com/yzElGZN.png)](#)\n\n\n\n\n\n\n\n\n\n\n\n# `$ ghcal`\n\n [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/ghcal.svg)](https://www.npmjs.com/package/ghcal) [![Downloads](https://img.shields.io/npm/dt/ghcal.svg)](https://www.npmjs.com/package/ghcal) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/@johnnyb?utm_source=github\u0026utm_medium=button\u0026utm_term=johnnyb\u0026utm_campaign=github)\n\n\u003ca href=\"https://www.buymeacoffee.com/H96WwChMy\" target=\"_blank\"\u003e\u003cimg src=\"https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png\" alt=\"Buy Me A Coffee\"\u003e\u003c/a\u003e\n\n\n\n\n\n\n\n\u003e See the GitHub contributions calendar of a user in the command line.\n\n\n\n\n\n\nIf 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).\n\n\n\n\n\n\n[![ghcal](http://i.imgur.com/OhgCb8o.png)](#)\n\n\n\n\n\n\n\n## :cloud: Installation\n\nYou can install the package globally and use it as command line tool:\n\n\n```sh\n# Using npm\nnpm install --global ghcal\n\n# Using yarn\nyarn global add ghcal\n```\n\n\nThen, run `ghcal --help` and see what the CLI tool can do.\n\n\n```\n$ ghcal --help\nUsage: ghcal [options]\n\nOptions:\n  -u, --username \u003cusername\u003e  The GitHub username. If you're using CLI GitHub,\n                             by default it will be your username.\n  -c, --cookie \u003ccookie\u003e      Your GitHub cookie. Useful to get private stats.\n  -s, --since \u003cdate\u003e         Optional start date.\n  -e, --until \u003cdate\u003e         Optional end date.\n  -n, --no-ansi              Forces the tool not to use ANSI styles.\n  -l, --light                Enables the light theme.\n  -h, --help                 Displays this help.\n  -v, --version              Displays version information.\n\nExamples:\n  ghcal -u ionicabizau\n  ghcal -u ionicabizau --light\n  ghcal -u ionicabizau --no-ansi\n  ghcal -u ionicabizau -s '1 January 2015' # All the commits from 1 January 2015 to now\n  ghcal -u ionicabizau -s '1 January 2015' -e '1 March 2015' # Select a time range\n\nNote that only the last year statistics are available.\n\nDocumentation can be found at https://github.com/IonicaBizau/ghcal\n```\n\n\n\n\n\n\n\n## Usage\n\n### Default behavior\n\n\nIf 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 \u003cyour-username\u003e`.\n\n```sh\nghcal\n```\n\n### Passing the username\n\n\n Using the `-u` (or `--username`) option, you can specify the GitHub username:\n\n```sh\n# Fetches the izuzak's contributions\n$ ghcal -u izuzak\n```\n\n### Themes\n\n\nIf you pass the `--light` option, then the light theme will be activated (the default theme is dark).\n\n```sh\n# jlord's contributions, light theme\n$ ghcal jlord --light\n```\n\n### No ANSI styles\n\n\nThe `--no-ansi` option disables any colors in the output. Unicode characters, without colors will be used.\n\n```sh\n# @pengywynn's contributions, but without ANSI styles\n$ ghcal pengwynn --no-ansi\n```\n\n\n\n\n\n\n\n\n## :clipboard: Example\n\n\n\nHere 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`):\n\n\n\n```js\nvar GhCal = require(\"ghcal\");\n\nGhCal(\"ionicabizau\", function (err, data) {\n    console.log(err || data);\n});\n```\n\n\n\n\n\n\n\n\n\n\n\n\n## :question: Get Help\n\nThere are few ways to get help:\n\n\n\n 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.\n 2. For bug reports and feature requests, open issues. :bug:\n 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:\n\n\n\n\n\n\n\n## :memo: Documentation\n\nFor full API reference, see the [DOCUMENTATION.md][docs] file.\n\n\n\n\n\n\n\n\n\n\n\n\n## :yum: How to contribute\nHave an idea? Found a bug? See [how to contribute][contributing].\n\n\n## :sparkling_heart: Support my projects\nI open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,\nthis 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).\n\nHowever, 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:\n\n\n - Starring and sharing the projects you like :rocket:\n - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:\n - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:\n - [![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).\n - **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`\n\n    ![](https://i.imgur.com/z6OQI95.png)\n\n\nThanks! :heart:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n## :dizzy: Where is this library used?\nIf you are using this library in one of your projects, add it in this list. :sparkles:\n\n - `github-stats`\n\n\n\n\n\n\n\n\n\n\n\n## :scroll: License\n\n[MIT][license] © [Ionică Bizău][website]\n\n\n\n\n\n\n[license]: /LICENSE\n[website]: https://ionicabizau.net\n[contributing]: /CONTRIBUTING.md\n[docs]: /DOCUMENTATION.md\n[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg\n[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg\n[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg\n[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg\n[patreon]: https://www.patreon.com/ionicabizau\n[amazon]: http://amzn.eu/hRo9sIZ\n[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=RVXDDLKKLQRJW\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FIonicaBizau%2Fghcal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FIonicaBizau%2Fghcal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FIonicaBizau%2Fghcal/lists"}