GIT quick statistics
git-quick-stats
is a simple and efficient way to access various statistics in git repository.
Any git repository contains tons 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 evenLinus Torvalds (himself:).
Table of Contents
- (Unix OS)
- (OS X)
- (Windows)
- Git log since / until
- Git log limit
- Git pathspec
- Tests
Screenshots
Usage
Or you can use (non-interactive) direct execution:
git-quick-stats
Possible arguments in short and long form:
- r , --suggest-reviewers show the best people to contact to review code -T, --detailed-git-stats give a detailed list of git stats -R, --git-stats-by-branch see detailed list of git stats by branch -d, --commits-per-day displays a list of commits per day -m, --commits-by-month displays a list of commits per month -w, --commits-by-weekday displays a list of commits per weekday -o, --commits-by-hour displays a list of commits per hour -A, --commits-by-author-by-hour displays a list of commits per hour by author -a, --commits-per-author displays a list of commits per author -S, --my-daily-stats see your current daily stats -C, --contributors see a list of everyone who contributed to the repo -b, --branch-tree show an ASCII graph of the git repo branch history -D, --branches-by-date show branches by date -c, --changelogs see changelogs -L, --changelogs-by-author see changelogs by author -j, --json-output save git log as a JSON formatted file to a specified area -h, - ?, --help display this help text in the terminal
Git log since / until
You can set variable_ GIT_SINCE
,_ GIT_UNTIL
and limit the git log
export_GIT_SINCE=""2017 - 01 - 20"export_GIT_UNTIL="2017 - 01 - 22""
then rungit quick-stats
affect all stats, except “My daily status” and “Git changelogs”)
You can set variable_ GIT_LIMIT
for limited output (it will affect: “Git changelogs” and “Branch tree view”)
You can exclude directory from the stats by usingpathspec
export_GIT_PATHSPEC='' (***********************************************************************:! directory'
Color themes
You can change to the legacy color scheme by toggling the variable_ MENU_THEME
betweendefault
andlegacy
export_MENU_THEME=legacy
Installation
(Unix like OS)
git clone https://github.com/arzzen/git-quick-stats.git&&CDgit-quick-stats sudo make install
git clone https://github.com/arzzen/git-quick-stats.git&&CDgit-quick-stats sudo make install
For uninstalling, open up the cloned directory and run
For update / reinstall
OS X (homebrew)
brew install git-quick-stats
Windows (cygwin)
- installer
- uninstaller
- Unix like OS with a proper shell
- Tools we use: awk; cat; column; echo; git; grep; head; seq; sort; tput; tr; uniq; WC
Dependences
bsdmainutils
apt install bsdmainutils
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.
- 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 standardSyntax markdown. Please submit your changes using the same syntax.
Tests
Licensing
MIT seeLICENSEfor the full license text.
Contributors
This project exists thanks to all the people who contribute.
Backers
Thank you to all our backers!
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
Sponsors
GIPHY App Key not set. Please check settings