Repository files navigation

git-quick-stats is 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 evenLinus Torvalds himself :).

Screenshots

Usage

• Interactive
• Non-interactive
• Command-line arguments
• Git log since and until
• Git log limit
• Git log options
• Git pathspec
• Git merge view strategy
• Color themes

Installation

• UNIX and Linux
• macOS
• Windows
• Docker

System requirements

• Dependencies

FAQ

Contribution

• Code reviews
• Some tips for good pull requests
• Formatting

Tests

Licensing

Contributors

• Backers
• Sponsors

git-quick-stats has a built-in interactive menu that can be executed as such:

git-quick-stats

Or

git quick-stats

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>

Or

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

Possible arguments in short and long form:

GENERATE OPTIONS    -T, --detailed-git-stats        give a detailed list of git stats    -R, --git-stats-by-branch        see detailed list of git stats by branch    -c, --changelogs        see changelogs    -L, --changelogs-by-author        see changelogs by author    -S, --my-daily-stats        see your current daily stats    -V, --csv-output-by-branch        output daily stats by branchin CSV format    -j, --json-output        save git log as a JSON formatted file to a specified areaLIST OPTIONS    -b, --branch-tree        show an ASCII graph of the git repo branchhistory    -D, --branches-by-date        show branches by date    -C, --contributors        see a list of everyone who contributed to the repo    -n, --new-contributors        list everyone who made their first contribution since a specified date    -a, --commits-per-author        displays a list of commits per author    -d, --commits-per-day        displays a list of commits per day    -m, --commits-by-month        displays a list of commits per month    -Y, --commits-by-year        displays a list of commits per year    -w, --commits-by-weekday        displays a list of commits per weekday    -W, --commits-by-author-by-weekday        displays a list of commits per weekday by author    -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    -z, --commits-by-timezone        displays a list of commits per timezone    -Z, --commits-by-author-by-timezone        displays a list of commits per timezone by authorCALENDAR OPTIONS    -k, --commits-calendar-by-author        shows a calendar heatmap of commits per day-of-week per monthfor a given author    -H, --commits-heatmap        shows a heatmap of commits per day-of-week per monthfor the last 30 daysSUGGEST OPTIONS    -r, --suggest-reviewers        show the best people to contact to review code    -h, -?, --help        display thishelp textin the terminal

You can set the variables_GIT_SINCE and/or_GIT_UNTIL before runninggit-quick-stats to limit the git log. These work similar to git's built-in--since and--until log options.

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

Once set, rungit 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. The default limit is10.

export _GIT_LIMIT=20

You can set_GIT_LOG_OPTIONS forgit log options:

export _GIT_LOG_OPTIONS="--ignore-all-space --ignore-blank-lines"

You can exclude a directory from the stats by usingpathspec

export _GIT_PATHSPEC=':!directory'

You can also exclude files from the stats. Note that it works with any alphanumeric, glob, or regex that git respects.

export _GIT_PATHSPEC=':!package-lock.json'

You can set the variable_GIT_MERGE_VIEW to enable merge commits to be part of the stats by setting_GIT_MERGE_VIEW toenable. You can also choose to only show merge commits by setting_GIT_MERGE_VIEW toexclusive. Default is to not show merge commits. These work similar to git's built-in--merges and--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--git-stats-by-branch and--csv-output-by-branch.

export _GIT_BRANCH="master"

You can set the variable_GIT_IGNORE_AUTHORS to filter out specific authors. It will affect the "All contributors", ""Suggested code reviewers" and "New contributors" options.

export _GIT_IGNORE_AUTHORS="(author@examle.com|username)"

You can sort contribution stats by fieldname,commits,insertions,deletions, orlines (total lines changed) and order (asc,desc). e.g.:commits-desc

export _GIT_SORT_BY="name-asc"

You can set _GIT_DAYS to set the number of days for the heatmap

export _GIT_DAYS=30

You can change to the legacy color scheme by toggling the variable_MENU_THEME betweendefault andlegacy.You can completely disable the color theme by setting the_MENU_THEME variable tonone.

export _MENU_THEME="legacy"# orexport _MENU_THEME="none"

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/git-quick-stats/git-quick-stats.git&&cd git-quick-statssudo make install

For uninstalling, open up the cloned directory and run

sudo make uninstall

For update/reinstall

sudo make reinstall

macOS requires GNU coreutils to be installed and for the non "g" aliasedversions to be exported to your path. The following is an example of how toperform this if you are using Homebrew as your package manager.

brew install coreutilsexport PATH="$HOMEBREW_PREFIX/opt/coreutils/libexec/gnubin:$PATH"

From there, you can install via Homebrew as follows:

brew install git-quick-stats

Or you can follow the UNIX and Linux instructions if you wish.

If you would like to default to using the GNU coreutils (recommended), then youcan addexport PATH="$HOMEBREW_PREFIX/opt/coreutils/libexec/gnubin:$PATH" toyour applicable~/.bash_profile,~/.zprofile, or other relevant profilebased on the shell of your choice.

If you are installing with Cygwin, use these scripts:

• installer
• uninstaller

If you are wishing to use this with WSL, follow the UNIX and Linux instructions.

You can use the Docker image provided:

• Build:docker build -t arzzen/git-quick-stats .
• Run interactive menu:docker run --rm -it -v $(pwd):/git arzzen/git-quick-stats
• Docker pull command:docker pull arzzen/git-quick-statsdocker repository

• An OS with a Bash shell
• Tools we use:

awkbasenamecatcolumndateechogitgrepheadprintfseqsorttputtruniq

• bsdextrautilsapt install bsdextrautils
• coreutilsapt install coreutils
• gawkapt install gawk
• grepapt install grep
• ncurses-binapt install ncurses-bin

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 aboutgit 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.

• 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 whatare the consequences? Where and what did you test? Some good tips:hereandhere.
• 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 currentHEAD. This make reviewing the code so much easier, and our history morereadable.

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

maketest

MIT seeLICENSE for the full license text.

This project exists thanks to all the people who contribute.