185 lines
6.4 KiB
Markdown
185 lines
6.4 KiB
Markdown
<!---------------------------------------------------------------------------->
|
||
<!-- STOP, LOOK & LISTEN! -->
|
||
<!-- ==================== -->
|
||
<!-- Do NOT edit this file directly since it's generated from a template -->
|
||
<!-- file, using https://github.com/IonicaBizau/node-blah -->
|
||
<!-- -->
|
||
<!-- If you found a typo in documentation, fix it in the source files -->
|
||
<!-- (`lib/*.js`) and make a pull request. -->
|
||
<!-- -->
|
||
<!-- If you have any other ideas, open an issue. -->
|
||
<!-- -->
|
||
<!-- Please consider reading the contribution steps (CONTRIBUTING.md). -->
|
||
<!-- * * * Thanks! * * * -->
|
||
<!---------------------------------------------------------------------------->
|
||
|
||
|
||
|
||
# `$ git-stats` [![Donate now][donate-now]][paypal-donations]
|
||
|
||
Local git statistics, including a GitHub-like contributions calendars.
|
||
|
||
I'd be curious to see your calendar with all your commits. Ping me on Twitter ([**@IonicaBizau**](https://twitter.com/IonicaBizau)). :smile: Until then, here's my calendar:
|
||
|
||
|
||
|
||
## Contents
|
||
|
||
- [Installation](#installation)
|
||
- [Usage](#usage)
|
||
- [Importing and deleting commits](#importing-and-deleting-commits)
|
||
- [Importing all the commits from GitHub and BitBucket](#importing-all-the-commits-from-github-and-bitbucket)
|
||
- [See the GitHub Contributions calendar](#see-the-github-contributions-calendar)
|
||
- [Documentation](#documentation)
|
||
- [How to contribute](#how-to-contribute)
|
||
|
||
## Installation
|
||
|
||
You can install the package globally and use it as command line tool:
|
||
|
||
```sh
|
||
# Install the package globally
|
||
npm i -g git-stats
|
||
# Initialize git hooks
|
||
# This is for tracking the new commits
|
||
curl -s https://raw.githubusercontent.com/IonicaBizau/git-stats/master/scripts/init-git-post-commit | bash
|
||
```
|
||
|
||
Then, run `git-stats --help` and see what the cli tool can do.
|
||
|
||
```sh
|
||
$ git-stats --help
|
||
TODO
|
||
```
|
||
|
||
### Importing and deleting commits
|
||
I know it's not nice to start your git commit calendar from scratch. That's why I
|
||
created [`git-stats-importer`](https://github.com/IonicaBizau/git-stats-importer)--a tool which imports or deletes the commits from selected repositories.
|
||
|
||
Check it out here: https://github.com/IonicaBizau/git-stats-importer
|
||
|
||
The usage is simple:
|
||
|
||
```sh
|
||
# Install the importer tool
|
||
$ npm install -g git-stats-importer
|
||
|
||
# Go to the repository you want to import
|
||
$ cd path/to/my-repository
|
||
|
||
# Import the commits
|
||
$ git-stats-importer
|
||
|
||
# ...or delete them if that's a dummy repository
|
||
$ git-stats-importer --delete
|
||
```
|
||
|
||
### Importing all the commits from GitHub and BitBucket
|
||
Yes, that's also possible. I [built a tool which downloads and then imports all the commits you have pushed to GitHub and BitBucket](https://github.com/IonicaBizau/repository-downloader)!
|
||
|
||
```sh
|
||
# Download the repository downloader
|
||
$ git clone https://github.com/IonicaBizau/repository-downloader.git
|
||
|
||
# Go to repository downloader
|
||
$ cd repository-downloader
|
||
|
||
# Install the dependencies
|
||
$ npm install
|
||
|
||
# Start downloading and importing
|
||
$ ./start
|
||
```
|
||
### What about the GitHub Contributions calendar?
|
||
If you want to visualize the calendars that appear on GitHub profiles, you can do that using [`ghcal`](https://github.com/IonicaBizau/ghcal).
|
||
|
||
```sh
|
||
# Install ghcal
|
||
$ npm install -g ghcal
|
||
|
||
# Check out @alysonla's contributions
|
||
$ ghcal -u alysonla
|
||
```
|
||
|
||
For more detailed documentation, check out the repository: https://github.com/IonicaBizau/ghcal.
|
||
|
||
If want to get even more GitHub stats in your terminal, you may want to try [`github-stats`](https://github.com/Ioni56caBizau/github-stats)--this is like `git-stats` but with data taken from GitHub.
|
||
|
||
## Using the configuration file
|
||
You can tweak the git-stats behavior using a configuration file in your home directory: `~/.git-stats-config.json`.
|
||
|
||
This file will contain a JSON object like below (in this example comments are added to explain what's going on, but you should not include them since the JSON format doesn't support such comments). Defaults are listed.
|
||
|
||
```js
|
||
{
|
||
// "DARK", "LIGHT" or an object interpreted by IonicaBizau/node-git-stats-colors
|
||
"theme": "DARK"
|
||
|
||
// The file where the commit hashes will be stored
|
||
, "path": "~/.git-stats"
|
||
|
||
// First day of the week
|
||
, first_day: "Sun"
|
||
|
||
// This defaults to *one year ago*
|
||
// It can be any parsable date
|
||
, since: undefined
|
||
|
||
// This defaults to *now*
|
||
// It can be any parsable date
|
||
, until: undefined
|
||
|
||
// Don't show authors by default
|
||
// If true, this will enable the authors pie
|
||
, authors: false
|
||
|
||
// No global activity by default
|
||
// If true, this will enable the global activity calendar in the current project
|
||
, global_activity: false
|
||
}
|
||
```
|
||
|
||
## Cross-platform compatibility
|
||
|
||
`git-stats` is working fine in terminal emulators supporting ANSI styles. It should work fine on Linux and OS X.
|
||
|
||
If you run `git-stats` to display graph on Windows, please use a terminal that can properly display ANSI colors.
|
||
Cygwin Terminal is known to work, while Windows Command Prompt and Git Bash do not. Improvements are more than welcome! :dizzy:
|
||
|
||
## Example
|
||
|
||
Here is an example how to use this package as library.
|
||
|
||
```js
|
||
// Dependencies
|
||
var GitStats = require("git-stats");
|
||
|
||
// Create the GitStats instance
|
||
var g1 = new GitStats();
|
||
|
||
// Display the ansi calendar
|
||
g1.ansiCalendar({
|
||
theme: "DARK"
|
||
}, function (err, data) {
|
||
console.log(err || data);
|
||
});
|
||
|
||
```
|
||
|
||
## Documentation
|
||
|
||
For full API reference, see the [DOCUMENTATION.md][docs] file.
|
||
|
||
## How to contribute
|
||
Have an idea? Found a bug? See [how to contribute][contributing].
|
||
|
||
## License
|
||
[KINDLY][license] © [Ionică Bizău][website]–The [LICENSE](/LICENSE) file contains
|
||
a copy of the license.
|
||
|
||
[license]: http://ionicabizau.github.io/kindly-license/?author=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica@gmail.com%3E&year=2015
|
||
[contributing]: /CONTRIBUTING.md
|
||
[website]: http://ionicabizau.net
|
||
[docs]: /DOCUMENTATION.md
|
||
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MG98D7NPFZ3MG
|
||
[donate-now]: http://i.imgur.com/jioicaN.png |