git-quick-statsis a simple and efficient way to access various statistics in a git repository.
Any git repository may contain tons of information about commits, contributors, and files. Extracting this information is not always trivial, mostly because there are 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 :).
git-quick-stats has a built-in interactive menu that can be executed as such:
For those who prefer to utilize command-line options,
git-quick-stats also has a non-interactive mode supporting both short and long options:
git quick-stats <optional-command-to-execute-directly>
Possible arguments in short and long form:
GENERATE OPTIONS-T, --detailed-git-statsgive a detailed list of git stats-R, --git-stats-by-branchsee detailed list of git stats by branch-c, --changelogssee changelogs-L, --changelogs-by-authorsee changelogs by author-S, --my-daily-statssee your current daily stats-V, --csv-output-by-branchoutput daily stats by branch in CSV format-j, --json-outputsave git log as a JSON formatted file to a specified areaLIST OPTIONS-b, --branch-treeshow an ASCII graph of the git repo branch history-D, --branches-by-dateshow branches by date-C, --contributorssee a list of everyone who contributed to the repo-a, --commits-per-authordisplays a list of commits per author-d, --commits-per-daydisplays a list of commits per day-Y, --commits-by-yeardisplays a list of commits per year-m, --commits-by-monthdisplays a list of commits per month-w, --commits-by-weekdaydisplays a list of commits per weekday-W, --commits-by-author-by-weekdaydisplays a list of commits per weekday by author-o, --commits-by-hourdisplays a list of commits per hour-A, --commits-by-author-by-hourdisplays a list of commits per hour by author-z, --commits-by-timezonedisplays a list of commits per timezone-Z, --commits-by-author-by-timezonedisplays a list of commits per timezone by authorSUGGEST OPTIONS-r, --suggest-reviewersshow the best people to contact to review code-h, -?, --helpdisplay this help text in the terminal
You can set the variables
_GIT_UNTIL before running
git-quick-stats to limit the git log. These work similar to git's built-in
--until log options.
export _GIT_SINCE="2017-01-20"export _GIT_UNTIL="2017-01-22"
Once set, run
git quick-stats as normal. Note that this affects all stats that parse the git log history until unset.
You can set variable
_GIT_LIMIT for limited output. It will affect the "changelogs" and "branch tree" options.
You can set
_GIT_LOG_OPTIONS for git log options:
export _GIT_LOG_OPTIONS="--ignore-all-space --ignore-blank-lines"
You can exclude a directory from the stats by using pathspec
You can also exclude files from the stats. Note that it works with any alphanumeric, glob, or regex that git respects.
You can set the variable
_GIT_MERGE_VIEW to enable merge commits to be part of the stats by setting
enable. You can also choose to only show merge commits by setting
exclusive. Default is to not show merge commits. These work similar to git's built-in
--no-merges log options.
export _GIT_MERGE_VIEW="enable"export _GIT_MERGE_VIEW="exclusive"
You can set the variable
_GIT_BRANCH to set the branch of the stats. Works with commands
You can change to the legacy color scheme by toggling the variable
If you are on at least Debian Bullseye or Ubuntu Focal you can use apt for installation:
apt install git-quick-stats
git clone https://github.com/arzzen/git-quick-stats.git && cd git-quick-statssudo make install
For uninstalling, open up the cloned directory and run
sudo make uninstall
sudo make reinstall
brew install git-quick-stats
Or you can follow the UNIX and Linux instructions if you wish.
If you are installing with Cygwin, use these scripts:
If you are wishing to use this with WSL, follow the UNIX and Linux instructions.
You can use the Docker image provided:
docker build -t arzzen/git-quick-stats .
docker run --rm -it -v $(pwd):/git arzzen/git-quick-stats
docker pull arzzen/git-quick-statsdocker repository
apt install bsdmainutils
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 the dos2unix app in cygwin as follows:
/bin/dos2unix.exe /usr/local/bin/git-quick-stats. This will convert the script from the CR-LF convention that Microsoft uses to the LF convention that UNIX, OS X, and Linux use. You should then should be able to run it as normal.
Q: How they could be used in a project with many git projects and statistics would show a summary of all git projects?
A: If you want to include submodule logs, you can try using the following:
export _GIT_LOG_OPTIONS="-p --submodule=log"
(more info about git log --submodule)
Want to contribute? Great! First, read this page.
All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose.
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.
This documentation is written using standard markdown syntax. Please submit your changes using the same syntax.
MIT see LICENSE for the full license text.
This project exists thanks to all the people who contribute.
Thank you to all our backers! 🙏 [Become a backer]
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]