arzzen.git-quick-stats/README.md at 206ebd8a7637081f005bba9c55d2eced77589343

mirror of https://github.com/arzzen/git-quick-stats.git synced 2026-09-15 01:56:19 -04:00

Tom Ice 2274ca1284 Improve color compatibility and other minor fixes

* Color was originally done with ANSI escape characters for defining
  different "expected" colors. However, this is not uniform across all
  terminals. To improve what the designers of this program expect
  colors to be, escape codes were replaced with tput equivalents.
  For more information, see the GNU manual here:

  https://www.gnu.org/software/termutils/manual/termutils-2.0/html_chapter/tput_1.html

* Limited scope of variables to their local scope instead of having them
  be global

* Renamed menu variables to aid in readability and adjusted formatting
  slightly to be more uniform

* Fixed a bug where option_picked was assigning an array to a string
  and relying on the default behavior of the shell to interpret it

* Added the -r option to "read" for safety, as read without -r will
  interpret backslashes before spaces/line feeds, which tends to
  be an unintended side effect

* Updated all backtick notation to the newer POSIX $(..) notation for
  aid in readability when paired next to single quotes and improved
  safety

* Updated the README.md to include missing utilities and fixed some
  minor formatting issues

2018-12-21 12:05:53 -05:00

6.1 KiB

Raw Blame History

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 even Linus Torvalds himself :).

Screenshots

Installation

Unix OS
OS X
Windows

Usage

Git log since/until
Git log limit
Git pathspec
Tests

System requirements

Dependences

Contribution

FAQ

License

Screenshots

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 ; seq ; tput.

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

make test

Licensing

MIT see LICENSE for the full license text.

6.1 KiB Raw Blame History Unescape Escape

GIT quick statistics

Table of Contents