mirror of
https://github.com/git-quick-stats/git-quick-stats.git
synced 2025-12-21 12:13:52 +01:00
5f71b785ac
* The main feature of this commit is addressing the feature request
of adding the ability to save the output as a file to use in other
tools. I decided to use the JSON format as it's relatively straight
forward and easy to create thanks to a few Google searches.
The original feature request was to add the ability to output any of
the options as a JSON/XML/YAML format. That said, because this entire project
is relying only on built-in shell utilities, we kind of have to format stuff
ourselves in relatively primitive tools such as awk, sed, and bash in order
to adhere to the "spirit" of this codebase.
It is possible to use Perl and/or Python, but that would defeat the purpose
of this, in my opinion. The downside of not using these tools is that it
might not be as robust and battle hardened as the others.
AS SUCH, THIS FEATURE IS CURRENTLY EXPERIMENTAL.
As people provide feedback, we can adjust this and possibly extend it to
more options. For now, it respects _GIT_SINCE and _GIT_UNTIL. It does not
respect variable expansion in paths, though, so saving it to a location such
as "${my_save_location}" will fail.
* Made some of the variables a bit more robust by utilizing the -r flag to
make the variables readonly. It should be noted that "local readonly" does
not work, nor does "readonly local". The best way to do this is either via
"local -r foo=bar" or "local foo=bar && readonly bar".
* Fixed a few comments describing how functions work.
* Added a .gitignore.
* Changed all functions to adhere to camelCase style for no real reason
other than consistency and a few other minor things.
* Closes #31
127 lines
2.5 KiB
Groff
127 lines
2.5 KiB
Groff
.TH git-quick-stats "1" "January 2019" "git-quick-stats" "User Commands"
|
|
.SH NAME
|
|
.B git\-quick\-stats
|
|
\- Simple and efficient way to access various stats in a git repository.
|
|
.SH SYNOPSIS
|
|
.PP
|
|
For non\-interactive mode:
|
|
.B git\-quick\-stats [OPTIONS]
|
|
.PP
|
|
For interactive mode:
|
|
.B git-quick-stats
|
|
.PP
|
|
.SH DESCRIPTION
|
|
.PP
|
|
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.
|
|
This program allows you to see detailed information about a git repository.
|
|
.PP
|
|
.SH OPTIONS
|
|
.HP
|
|
\fB\-r\fR, \fB\-\-suggest\-reviewers\fR
|
|
.IP
|
|
show the best people to contact to review code
|
|
.HP
|
|
.PP
|
|
\fB\-T\fR, \fB\-\-detailed\-git\-stats\fR
|
|
.IP
|
|
give a detailed list of git stats
|
|
.HP
|
|
.PP
|
|
\fB\-R\fR, \fB\-\-git\-stats\-by\-branch\fR
|
|
.IP
|
|
see detailed list of git stats by branch
|
|
.HP
|
|
.PP
|
|
\fB\-d\fR, \fB\-\-commits\-per\-day\fR
|
|
.IP
|
|
displays a list of commits per day
|
|
.HP
|
|
.PP
|
|
\fB\-m\fR, \fB\-\-commits\-by\-month\fR
|
|
.IP
|
|
displays a list of commits per month
|
|
.HP
|
|
.PP
|
|
\fB\-w\fR, \fB\-\-commits\-by\-weekday\fR
|
|
.IP
|
|
displays a list of commits per weekday
|
|
.HP
|
|
.PP
|
|
\fB\-o\fR, \fB\-\-commits\-by\-hour\fR
|
|
.IP
|
|
displays a list of commits per hour
|
|
.HP
|
|
.PP
|
|
\fB\-A\fR, \fB\-\-commits\-by\-author\-by\-hour\fR
|
|
.IP
|
|
displays a list of commits per hour by author
|
|
.HP
|
|
.PP
|
|
\fB\-a\fR, \fB\-\-commits\-per\-author\fR
|
|
.IP
|
|
displays a list of commits per author
|
|
.HP
|
|
.PP
|
|
\fB\-S\fR, \fB\-\-my\-daily\-stats\fR
|
|
.IP
|
|
see your current daily stats
|
|
.HP
|
|
.PP
|
|
\fB\-C\fR, \fB\-\-contributors\fR
|
|
.IP
|
|
see a list of everyone who contributed to the repo
|
|
.HP
|
|
.PP
|
|
\fB\-b\fR, \fB\-\-branch\-tree\fR
|
|
.IP
|
|
show an ASCII graph of the git repo branch history
|
|
.HP
|
|
.PP
|
|
\fB\-D\fR, \fB\-\-branches\-by\-date\fR
|
|
.IP
|
|
show branches by date
|
|
.HP
|
|
.PP
|
|
\fB\-c\fR, \fB\-\-changelogs\fR
|
|
.IP
|
|
see changelogs
|
|
.HP
|
|
.PP
|
|
\fB\-L\fR, \fB\-\-changelogs\-by\-author\fR
|
|
.IP
|
|
see changelogs by author
|
|
.HP
|
|
.PP
|
|
\fB\-j\fR, \fB\-\-json\-output\fR
|
|
.IP
|
|
save git log as a JSON formatted file to a specified area
|
|
.HP
|
|
.PP
|
|
\fB\-h\fR, \-?, \fB\-\-help\fR
|
|
.IP
|
|
display this help text in the terminal
|
|
.PP
|
|
.SH ADDITIONAL USAGE
|
|
You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log, example:
|
|
.IP
|
|
.PP
|
|
.B export _GIT_SINCE="2017\-01\-20"
|
|
.IP
|
|
.PP
|
|
You can set _GIT_LIMIT for limited output log, example:
|
|
.PP
|
|
.B export _GIT_LIMIT=20
|
|
.PP
|
|
You can exclude a directory from the stats by using pathspec, example:
|
|
.PP
|
|
.B export _GIT_PATHSPEC=':!directory'
|
|
.PP
|
|
You can switch to the legacy color scheme, example:
|
|
.PP
|
|
.B export _MENU_THEME=legacy
|
|
.
|
|
.fi
|
|
|