▁▅▆▃▅ Git quick statistics is a simple and efficient way to access various statistics in git repository.
Clone or download
arzzen Merge pull request #45 from thangdc94/thangdc94-patch-1
fix: author not show fullname in contribution stats
Latest commit 42a657b Sep 21, 2018

README.md

GIT quick statistics Tweet

Travis Homebrew package Linuxbrew package

git quick-stats is a simple and efficient way to access various statistics in git repository.

Any git repository contains a tonne of information about commits, contributors, and files. Extracting this information is not always trivial, mostly because of a gadzillion options to a gadzillion git commands – I don’t think there is a single person alive who knows them all. Probably not even Linus Torvalds himself :).

Table of Contents

Screenshots

Installation

Usage

System requirements

Contribution

FAQ

License

Screenshots

screenshot from 2017-04-02 17-10-21

screenshot from 2017-04-02 17-09-13

screenshot from 2017-04-02 17-09-31

screenshot from 2017-04-02 17-09-45

screenshot from 2017-04-02 17-08-28

Usage

git quick-stats
# or 
git-quick-stats

Or you can use (non-interactive) direct execution:

git quick-stats <optional-command-to-execute-directly>

Possible arguments:

suggestReviewers, detailedGitStats, commitsByHour, commitsByWeekday, commitsByMonth, commitsPerDay, commitsPerAuthor, myDailyStats, contributors, branchTree, branchesByDate, changelogs, changelogsByAuthor

Git log since / until

You can set variable _GIT_SINCE, _GIT_UNTIL and limit the git log

export _GIT_SINCE="2017-20-01"
export _GIT_UNTIL="2017-22-01"

then run git quick-stats (affect all stats, except "My daily status" and "Git changelogs" )

Git log limit

You can set variable _GIT_LIMIT for limited output (it will affect: "Git changelogs" and "Branch tree view" )

export _GIT_LIMIT=20

Git pathspec

You can exclude directory from the stats by using pathspec

export _GIT_PATHSPEC=':!directory'

Installation

Unix like OS

git clone https://github.com/arzzen/git-quick-stats.git && cd git-quick-stats
sudo make install

For uninstalling, open up the cloned directory and run

sudo make uninstall

For update/reinstall

sudo make reinstall

OS X (homebrew)

brew install git-quick-stats

Windows (cygwin)

System requirements

  • Unix like OS with a proper shell
  • Tools we use: git ; awk ; sed ; tr ; echo ; grep ; cut ; sort ; head ; uniq ; column.

Dependences

FAQ

Q: I get some errors after run git-quick-stats in cygwin like /usr/local/bin/git-quick-stats: line 2: $'\r': command not found

A: You can run dos2unix app in cygwin /bin/dos2unix.exe /usr/local/bin/git-quick-stats. This will convert it to Unix format and you then should be able to run it.

Contribution

Want to contribute? Great! First, read this page.

Code reviews

All submissions, including submissions by project members, require review. We use Github pull requests for this purpose.

Some tips for good pull requests:

  • Use our code When in doubt, try to stay true to the existing code of the project.
  • Write a descriptive commit message. What problem are you solving and what are the consequences? Where and what did you test? Some good tips: here and here.
  • If your PR consists of multiple commits which are successive improvements / fixes to your first commit, consider squashing them into a single commit (git rebase -i) such that your PR is a single commit on top of the current HEAD. This make reviewing the code so much easier, and our history more readable.

Formatting

This documentation is written using standard markdown syntax. Please submit your changes using the same syntax.

Tests

codecov

make test

Licensing

MIT see LICENSE for the full license text.