mirror of
https://github.com/git-quick-stats/git-quick-stats.git
synced 2025-12-16 12:00:12 +01:00
206 lines
5.3 KiB
Groff
206 lines
5.3 KiB
Groff
.TH git-quick-stats "1" "June 2025" "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 GENERATE OPTIONS
|
||
.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\-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\-S\fR, \fB\-\-my\-daily\-stats\fR
|
||
.IP
|
||
see your current daily stats
|
||
.HP
|
||
.PP
|
||
\fB\-V\fR, \fB\-\-csv\-output\-by\-branch\fR
|
||
.IP
|
||
output daily stats by branch in CSV format
|
||
.HP
|
||
.PP
|
||
\fB\-j\fR, \fB\-\-json\-output\fR
|
||
.IP
|
||
save git log as a JSON formatted file to a specified area
|
||
.HP
|
||
.SH LIST OPTIONS
|
||
.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\-\-contributors\fR
|
||
.IP
|
||
see a list of everyone who contributed to the repo
|
||
.HP
|
||
.PP
|
||
\fB\-n\fR, \fB\-\-new\-contributors\fR
|
||
.IP
|
||
list everyone who made their first contribution since a specified date
|
||
.HP
|
||
.PP
|
||
\fB\-a\fR, \fB\-\-commits\-per\-author\fR
|
||
.IP
|
||
displays a list of commits per author
|
||
.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\-Y\fR, \fB\-\-commits\-by\-year\fR
|
||
.IP
|
||
displays a list of commits per year
|
||
.HP
|
||
.PP
|
||
\fB\-w\fR, \fB\-\-commits\-by\-weekday\fR
|
||
.IP
|
||
displays a list of commits per weekday
|
||
.HP
|
||
.PP
|
||
\fB\-W\fR, \fB\-\-commits\-by\-author\-by\-weekday\fR
|
||
.IP
|
||
displays a list of commits per weekday by author
|
||
.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\-z\fR, \fB\-\-commits\-by\-timezone\fR
|
||
.IP
|
||
displays a list of commits per timezone
|
||
.HP
|
||
.PP
|
||
\fB\-Z\fR, \fB\-\-commits\-by\-author\-by\-timezone\fR
|
||
.IP
|
||
displays a list of commits per timezone by author
|
||
.HP
|
||
.PP
|
||
\fB\-\-activity\-calendar\fR
|
||
.IP
|
||
displays a calendar-style grid of commit activity per day-of-week and month for a selected author.
|
||
.HP
|
||
.SH SUGGEST OPTIONS
|
||
.PP
|
||
\fB\-r\fR, \fB\-\-suggest\-reviewers\fR
|
||
.IP
|
||
show the best people to contact to review code
|
||
.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:
|
||
.PP
|
||
.B export _GIT_SINCE="2017\-01\-20"
|
||
.PP
|
||
You can set _GIT_LIMIT for limited output log, example:
|
||
.PP
|
||
.B export _GIT_LIMIT=20
|
||
.PP
|
||
You can set _GIT_LOG_OPTIONS for git log options, example:
|
||
.PP
|
||
.B export _GIT_LOG_OPTIONS="--ignore-all-space --ignore-blank-lines"
|
||
.PP
|
||
You can exclude directories or files from the stats by using pathspec, example:
|
||
.PP
|
||
.B export _GIT_PATHSPEC=':!pattern'
|
||
.PP
|
||
You can set _GIT_MERGE_VIEW to show merge commits with normal commits, example:
|
||
.PP
|
||
.B export _GIT_MERGE_VIEW="enable"
|
||
.PP
|
||
You can also set _GIT_MERGE_VIEW to only show merge commits, example:
|
||
.PP
|
||
.B export _GIT_MERGE_VIEW="exclusive"
|
||
.PP
|
||
You can switch to the legacy color scheme, example:
|
||
.PP
|
||
.B export _MENU_THEME=legacy
|
||
.PP
|
||
You can set _GIT_BRANCH to set the branch of the stats, example:
|
||
.PP
|
||
.B export _GIT_BRANCH="master"
|
||
.PP
|
||
.SH Calendar activity output
|
||
.PP
|
||
\fBactivity-calendar\fR outputs a visual grid of commit activity for a selected author, grouped by day-of-week (rows: Mon..Sun) and month (columns: Jan..Dec). Each cell is 3 characters wide, separated by one space.
|
||
.PP
|
||
Sample output:
|
||
.PP
|
||
.nf
|
||
Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
|
||
Mon ▓▓▓ ░░░ ▒▒▒ ░░░ ░░░ ▒▒▒ ▓▓▓ ░░░ ░░░ ▓▓▓ ▒▒▒ ▒▒▒
|
||
Tue ▒▒▒ ░░░ ▒▒▒ ░░░ ▒▒▒ ░░░ ▒▒▒ ▓▓▓ ▒▒▒ ░░░ ░░░ ░░░
|
||
Wed ░░░ ▓▓▓ ░░░ ▓▓▓ ▒▒▒ ░░░ ░░░ ▒▒▒ ░░░ ░░░ ▓▓▓ ░░░
|
||
Thu ░░░ ▒▒▒ ░░░ ░░░ ▒▒▒ ░░░ ▓▓▓ ▒▒▒ ▒▒▒ ░░░ ░░░ ▒▒▒
|
||
Fri ▒▒▒ ░░░ ▒▒▒ ▓▓▓ ░░░ ▓▓▓ ▒▒▒ ░░░ ▒▒▒ ░░░ ▒▒▒ ░░░
|
||
Sat ░░░ ░░░ ▒▒▒ ░░░ ░░░ ░░░ ▒▒▒ ░░░ ▒▒▒ ▓▓▓ ▒▒▒ ░░░
|
||
Sun ▓▓▓ ░░░ ▓▓▓ ░░░ ░░░ ▓▓▓ ░░░ ▒▒▒ ░░░ ░░░ ▓▓▓ ░░░
|
||
|
||
Legend: ... = 0 ░░░ = 1–2 ▒▒▒ = 3–5 ▓▓▓ = 6+ commits
|
||
.PP
|
||
You can set _GIT_IGNORE_AUTHORS to filter out specific authors, example:
|
||
.PP
|
||
.B export _GIT_IGNORE_AUTHORS="(author@examle.com|username)"
|
||
.
|
||
.fi
|
||
|
||
.PP
|
||
.SH SEE ALSO
|
||
.BR git (1)
|
||
.PP
|
||
Project homepage:
|
||
.UR https://github.com/git-quick-stats/git-quick-stats
|
||
.UE |