Merge pull request #195 from tomice/issues/194-flatten-awk-arrays-for-bsd-awk-compat

Flatten arrays for wider awk compatibility

.github/FUNDING.yml

@@ -1,6 +1 @@
 # These are supported funding model platforms
-
-github: [arzzen]
-open_collective: git-quick-stats
-ko_fi: lukasmestan 
-custom: ['https://lukasmestan.com/thanks/']

.mailmap

@@ -1,3 +1,3 @@
-Lukas Mestan <lukas.mestan@gmail.com> Lukáš Mešťan <arzzen@users.noreply.github.com> 
+Lukas <test@gmail.com> Lukáš <arzzen@users.noreply.github.com> 
-Lukas Mestan <lukas.mestan@gmail.com> arzzen 
+Lukas <lukas@gmail.com> arzzen 
 

CITATION.cff

@@ -0,0 +1,25 @@
+cff-version: 1.2.0
+title: Git Quick Stats
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - name-particle: tomice
+  - name-particle: arzzen
+identifiers:
+  - type: url
+    value: "https://github.com/git-quick-stats"
+    description: >-
+      Simple and efficient way to access various statistics
+      in a git repository
+repository-code: "https://github.com/git-quick-stats/git-quick-stats"
+url: "https://git-quick-stats.sh/"
+abstract: >-
+  Git-quick-stats is a simple and efficient way to access
+  various statistics in a git repository.
+keywords:
+  - git
+  - stats
+license: MIT
+version: 2.6.2

Dockerfile

@@ -4,7 +4,7 @@ FROM alpine
 COPY . /app
 
 # Install required packages & build git-quick-stats
-RUN     apk add --no-cache bash git make ncurses util-linux \
+RUN     apk add --no-cache bash git make ncurses coreutils util-linux \
     &&  cd /app \
     &&  make install \
     &&  rm -rf /app \
@@ -23,5 +23,6 @@ ENV _GIT_SINCE= \
     TERM=xterm-256color
 
 WORKDIR /git
+RUN git config --global --add safe.directory /git
 ENTRYPOINT [ "/usr/local/bin/docker-entrypoint" ]
-CMD [ "/usr/bin/git", "quick-stats" ]
+CMD [ "/usr/bin/git", "quick-stats" ]

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Lukáš Mešťan
+Copyright (c) 2024 git-quick-stats.sh
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -30,8 +30,8 @@ uninstall:
 	@$(TASK_DONE)
 
 reinstall:
-	@curl -sO https://raw.githubusercontent.com/arzzen/git-quick-stats/master/git-quick-stats
+	@curl -sO https://raw.githubusercontent.com/git-quick-stats/git-quick-stats/master/git-quick-stats
-	@curl -sO https://raw.githubusercontent.com/arzzen/git-quick-stats/master/git-quick-stats.1
+	@curl -sO https://raw.githubusercontent.com/git-quick-stats/git-quick-stats/master/git-quick-stats.1
 	$(MAKE) install
 	@$(TASK_DONE)
 

README.md

@@ -1,397 +1,411 @@
-# GIT quick statistics [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Simple%20and%20efficient%20way%20to%20access%20various%20statistics%20in%20git%20repository&url=https://github.com/arzzen/git-quick-stat&via=arzzen&hashtags=git,stats,tool,statistics,developers)
+# GIT quick statistics [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Simple%20and%20efficient%20way%20to%20access%20various%20statistics%20in%20git%20repository&url=https://github.com/arzzen/git-quick-stat&via=arzzen&hashtags=git,stats,tool,statistics,developers)
-
+
-[![Backers on Open Collective](https://opencollective.com/git-quick-stats/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/git-quick-stats/sponsors/badge.svg)](#sponsors)  [![Homebrew package](https://repology.org/badge/version-for-repo/homebrew/git-quick-stats.svg)](https://formulae.brew.sh/formula/git-quick-stats#default)
+[![Homebrew package](https://repology.org/badge/version-for-repo/homebrew/git-quick-stats.svg)](https://formulae.brew.sh/formula/git-quick-stats#default)
-
+
-> `git-quick-stats` is a simple and efficient way to access various statistics in a git repository.
+> `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 even [Linus Torvalds](https://github.com/torvalds) himself :).
+> 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](https://github.com/torvalds) himself :).
-
+
-![mainMenuScreenshot](https://github.com/user-attachments/assets/05a20ff1-44f6-4e44-9d62-c2c089f9ff4e)
+![mainImageScreenshot](https://github.com/user-attachments/assets/7d8637a4-5a67-49f6-8724-ca7548b987c6)
-
+
-## Table of Contents
+## Table of Contents
-
+
-[**Screenshots**](#screenshots)
+[**Screenshots**](#screenshots)
-
+
-[**Usage**](#usage)
+[**Usage**](#usage)
-
+
-* [**Interactive**](#interactive)
+- [**Interactive**](#interactive)
-* [**Non-interactive**](#non-interactive)
+- [**Non-interactive**](#non-interactive)
-* [**Command-line arguments**](#command-line-arguments)
+- [**Command-line arguments**](#command-line-arguments)
-* [**Git log since and until**](#git-log-since-and-until)
+- [**Git log since and until**](#git-log-since-and-until)
-* [**Git log limit**](#git-log-limit)
+- [**Git log limit**](#git-log-limit)
-* [**Git log options**](#git-log-options)
+- [**Git log options**](#git-log-options)
-* [**Git pathspec**](#git-pathspec)
+- [**Git pathspec**](#git-pathspec)
-* [**Git merge view strategy**](#git-merge-view-strategy)
+- [**Git merge view strategy**](#git-merge-view-strategy)
-* [**Color themes**](#color-themes)
+- [**Color themes**](#color-themes)
-
+
-[**Installation**](#installation)
+[**Installation**](#installation)
-
+
-* [**UNIX and Linux**](#unix-and-linux)
+- [**UNIX and Linux**](#unix-and-linux)
-* [**macOS**](#macos-homebrew)
+- [**macOS**](#macos-homebrew)
-* [**Windows**](#windows)
+- [**Windows**](#windows)
-* [**Docker**](#docker)
+- [**Docker**](#docker)
-
+
-[**System requirements**](#system-requirements)
+[**System requirements**](#system-requirements)
-
+
-* [**Dependencies**](#dependencies)
+- [**Dependencies**](#dependencies)
-
+
-[**FAQ**](#faq)
+[**FAQ**](#faq)
-
+
-[**Contribution**](#contribution)
+[**Contribution**](#contribution)
-
+
-* [**Code reviews**](#code-reviews)
+- [**Code reviews**](#code-reviews)
-* [**Some tips for good pull requests**](#some-tips-for-good-pull-requests)
+- [**Some tips for good pull requests**](#some-tips-for-good-pull-requests)
-* [**Formatting**](#formatting)
+- [**Formatting**](#formatting)
-
+
-[**Tests**](#tests)
+[**Tests**](#tests)
-
+
-[**Licensing**](#licensing)
+[**Licensing**](#licensing)
-
+
-[**Contributors**](#contributors)
+[**Contributors**](#contributors)
-
+
-* [**Backers**](#backers)
+- [**Backers**](#backers)
-* [**Sponsors**](#sponsors)
+- [**Sponsors**](#sponsors)
-
+
-## Screenshots
+## Screenshots
-
+
-![commitsByWeekdayScreenshot](https://github.com/user-attachments/assets/3a55f3ac-8801-4bbf-9b3a-92b53a64631e)
+![commitsByWeekdayScreenshot](https://github.com/user-attachments/assets/3496d245-6385-47d1-878a-726e79100eb1)
-
+
-![commitsByHourScreenshot](https://github.com/user-attachments/assets/d7de5280-8bb9-4391-9c6c-7e688f2df171)
+![commitsByHourScreenshot](https://github.com/user-attachments/assets/9f1d69d9-46e0-411d-a5ed-905ffdfb887a)
-
+
-## Usage
+![commitActivityScreenshot](https://github.com/user-attachments/assets/693fff31-65c7-4b9f-a011-6114a2d10a26)
-
+
-### Interactive
+## Usage
-
+
-`git-quick-stats` has a built-in interactive menu that can be executed as such:
+### Interactive
-
+
-```bash
+`git-quick-stats` has a built-in interactive menu that can be executed as such:
-git-quick-stats
+
-```
+```bash
-
+git-quick-stats
-Or
+```
-
+
-```bash
+Or
-git quick-stats
+
-```
+```bash
-
+git quick-stats
-### Non-interactive
+```
-
+
-For those who prefer to utilize command-line options, `git-quick-stats` also has a non-interactive mode supporting both short and long options:
+### Non-interactive
-
+
-```bash
+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>
+
-```
+```bash
-
+git-quick-stats <optional-command-to-execute-directly>
-Or
+```
-
+
-```bash
+Or
-git quick-stats <optional-command-to-execute-directly>
+
-```
+```bash
-
+git quick-stats <optional-command-to-execute-directly>
-### Command-line arguments
+```
-
+
-Possible arguments in short and long form:
+### Command-line arguments
-
+
-```bash
+Possible arguments in short and long form:
-GENERATE OPTIONS
+
-    -T, --detailed-git-stats
+```bash
-        give a detailed list of git stats
+GENERATE OPTIONS
-    -R, --git-stats-by-branch
+    -T, --detailed-git-stats
-        see detailed list of git stats by branch
+        give a detailed list of git stats
-    -c, --changelogs
+    -R, --git-stats-by-branch
-        see changelogs
+        see detailed list of git stats by branch
-    -L, --changelogs-by-author
+    -c, --changelogs
-        see changelogs by author
+        see changelogs
-    -S, --my-daily-stats
+    -L, --changelogs-by-author
-        see your current daily stats
+        see changelogs by author
-    -V, --csv-output-by-branch
+    -S, --my-daily-stats
-        output daily stats by branch in CSV format
+        see your current daily stats
-    -j, --json-output
+    -V, --csv-output-by-branch
-        save git log as a JSON formatted file to a specified area
+        output daily stats by branch in CSV format
-
+    -j, --json-output
-LIST OPTIONS
+        save git log as a JSON formatted file to a specified area
-    -b, --branch-tree
+
-        show an ASCII graph of the git repo branch history
+LIST OPTIONS
-    -D, --branches-by-date
+    -b, --branch-tree
-        show branches by date
+        show an ASCII graph of the git repo branch history
-    -C, --contributors
+    -D, --branches-by-date
-        see a list of everyone who contributed to the repo
+        show branches by date
-    -n, --new-contributors
+    -C, --contributors
-        list everyone who made their first contribution since a specified date
+        see a list of everyone who contributed to the repo
-    -a, --commits-per-author
+    -n, --new-contributors
-        displays a list of commits per author
+        list everyone who made their first contribution since a specified date
-    -d, --commits-per-day
+    -a, --commits-per-author
-        displays a list of commits per day
+        displays a list of commits per author
-    -Y, --commits-by-year
+    -d, --commits-per-day
-        displays a list of commits per year
+        displays a list of commits per day
-    -m, --commits-by-month
+    -m, --commits-by-month
-        displays a list of commits per month
+        displays a list of commits per month
-    -w, --commits-by-weekday
+    -Y, --commits-by-year
-        displays a list of commits per weekday
+        displays a list of commits per year
-    -W, --commits-by-author-by-weekday
+    -w, --commits-by-weekday
-        displays a list of commits per weekday by author
+        displays a list of commits per weekday
-    -o, --commits-by-hour
+    -W, --commits-by-author-by-weekday
-        displays a list of commits per hour
+        displays a list of commits per weekday by author
-    -A, --commits-by-author-by-hour
+    -o, --commits-by-hour
-        displays a list of commits per hour by author
+        displays a list of commits per hour
-    -z, --commits-by-timezone
+    -A, --commits-by-author-by-hour
-        displays a list of commits per timezone
+        displays a list of commits per hour by author
-    -Z, --commits-by-author-by-timezone
+    -z, --commits-by-timezone
-        displays a list of commits per timezone by author
+        displays a list of commits per timezone
-
+    -Z, --commits-by-author-by-timezone
-SUGGEST OPTIONS
+        displays a list of commits per timezone by author
-    -r, --suggest-reviewers
+
-        show the best people to contact to review code
+CALENDAR OPTIONS
-    -h, -?, --help
+    -k, --commits-calendar-by-author
-        display this help text in the terminal
+        shows a calendar heatmap of commits per day-of-week per month for a given author
-```
+    -H, --commits-heatmap
-
+        shows a heatmap of commits per day-of-week per month for the last 30 days
-### Git log since and until
+
-
+SUGGEST OPTIONS
-You can set the variables `_GIT_SINCE` and/or `_GIT_UNTIL` before running `git-quick-stats` to limit the git log. These work similar to git's built-in `--since` and `--until` log options.
+    -r, --suggest-reviewers
-
+        show the best people to contact to review code
-```bash
+    -h, -?, --help
-export _GIT_SINCE="2017-01-20"
+        display this help text in the terminal
-export _GIT_UNTIL="2017-01-22"
+```
-```
+
-
+### Git log since and until
-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 the variables `_GIT_SINCE` and/or `_GIT_UNTIL` before running `git-quick-stats` to limit the git log. These work similar to git's built-in `--since` and `--until` log options.
-### Git log limit
+
-
+```bash
-You can set variable `_GIT_LIMIT` for limited output. It will affect the "changelogs" and "branch tree" options. The default limit is `10`.
+export _GIT_SINCE="2017-01-20"
-
+export _GIT_UNTIL="2017-01-22"
-```bash
+```
-export _GIT_LIMIT=20
+
-```
+Once set, run `git quick-stats` as normal. Note that this affects all stats that parse the git log history until unset.
-
+
-### Git log options
+### Git log limit
-
+
-You can set `_GIT_LOG_OPTIONS` for [git log options](https://git-scm.com/docs/git-log#_options):
+You can set variable `_GIT_LIMIT` for limited output. It will affect the "changelogs" and "branch tree" options. The default limit is `10`.
-
+
-```bash
+```bash
-export _GIT_LOG_OPTIONS="--ignore-all-space --ignore-blank-lines"
+export _GIT_LIMIT=20
-```
+```
-
+
-### Git pathspec
+### Git log options
-
+
-You can exclude a directory from the stats by using [pathspec](https://git-scm.com/docs/gitglossary#gitglossary-aiddefpathspecapathspec)
+You can set `_GIT_LOG_OPTIONS` for [git log options](https://git-scm.com/docs/git-log#_options):
-
+
-```bash
+```bash
-export _GIT_PATHSPEC=':!directory'
+export _GIT_LOG_OPTIONS="--ignore-all-space --ignore-blank-lines"
-```
+```
-
+
-You can also exclude files from the stats. Note that it works with any alphanumeric, glob, or regex that git respects.
+### Git pathspec
-
+
-```bash
+You can exclude a directory from the stats by using [pathspec](https://git-scm.com/docs/gitglossary#gitglossary-aiddefpathspecapathspec)
-export _GIT_PATHSPEC=':!package-lock.json'
+
-```
+```bash
-
+export _GIT_PATHSPEC=':!directory'
-### Git merge view strategy
+```
-
+
-You can set the variable `_GIT_MERGE_VIEW` to enable merge commits to be part of the stats by setting `_GIT_MERGE_VIEW` to `enable`. You can also choose to only show merge commits by setting `_GIT_MERGE_VIEW` to `exclusive`. Default is to not show merge commits. These work similar to git's built-in `--merges` and `--no-merges` log options.
+You can also exclude files from the stats. Note that it works with any alphanumeric, glob, or regex that git respects.
-
+
-```bash
+```bash
-export _GIT_MERGE_VIEW="enable"
+export _GIT_PATHSPEC=':!package-lock.json'
-export _GIT_MERGE_VIEW="exclusive"
+```
-```
+
-
+### Git merge view strategy
-### Git branch
+
-
+You can set the variable `_GIT_MERGE_VIEW` to enable merge commits to be part of the stats by setting `_GIT_MERGE_VIEW` to `enable`. You can also choose to only show merge commits by setting `_GIT_MERGE_VIEW` to `exclusive`. Default is to not show merge commits. These work similar to git's built-in `--merges` and `--no-merges` log options.
-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`.
+
-
+```bash
-```bash
+export _GIT_MERGE_VIEW="enable"
-export _GIT_BRANCH="master"
+export _GIT_MERGE_VIEW="exclusive"
-```
+```
-
+
-### Color themes
+### Git branch
-
+
-You can change to the legacy color scheme by toggling the variable `_MENU_THEME` between `default` and `legacy`
+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`.
-
+
-```bash
+```bash
-export _MENU_THEME="legacy"
+export _GIT_BRANCH="master"
-```
+```
-
+
-![legacyThemeScreenshot](https://github.com/user-attachments/assets/3b319c1a-827f-47b8-bbfa-b8b59a39deef)
+### Ignore authors
-
+
-## Installation
+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.
-
+
-### Debian and Ubuntu
+```bash
-
+export _GIT_IGNORE_AUTHORS="(author@examle.com|username)"
-If you are on at least Debian Bullseye or Ubuntu Focal you can use apt for installation:
+```
-
+
-```bash
+### Sorting contribution stats
-apt install git-quick-stats
+
-```
+You can sort contribution stats by field `name`, `commits`, `insertions`, `deletions`, or `lines` (total lines changed) and order (`asc`, `desc`). e.g.: `commits-desc`
-
+
-### UNIX and Linux
+```bash
-
+export _GIT_SORT_BY="name-asc"
-```bash
+```
-git clone https://github.com/arzzen/git-quick-stats.git && cd git-quick-stats
+
-sudo make install
+### Commit days
-```
+
-
+You can set \_GIT_DAYS to set the number of days for the heatmap
-For uninstalling, open up the cloned directory and run
+
-
+```bash
-```bash
+export _GIT_DAYS=30
-sudo make uninstall
+```
-```
+
-
+### Color themes
-For update/reinstall
+
-
+You can change to the legacy color scheme by toggling the variable `_MENU_THEME` between `default` and `legacy`.
-```bash
+You can completely disable the color theme by setting the `_MENU_THEME` variable to `none`.
-sudo make reinstall
+
-```
+```bash
-
+export _MENU_THEME="legacy"
-### macOS (homebrew)
+# or
-
+export _MENU_THEME="none"
-macOS requires GNU coreutils to be installed and for the non "g" aliased
+```
-versions to be exported to your path. The following is an example of how to
+
-perform this if you are using Homebrew as your package manager.
+![legacyThemeScreenshot](https://github.com/user-attachments/assets/3b319c1a-827f-47b8-bbfa-b8b59a39deef)
-
+
-```bash
+## Installation
-brew install coreutils
+
-export PATH="$HOMEBREW_PREFIX/opt/coreutils/libexec/gnubin:$PATH"
+### Debian and Ubuntu
-```
+
-
+If you are on at least Debian Bullseye or Ubuntu Focal you can use apt for installation:
-From there, you can install via Homebrew as follows:
+
-
+```bash
-```bash
+apt install git-quick-stats
-brew install git-quick-stats
+```
-```
+
-
+### UNIX and Linux
-Or you can follow the UNIX and Linux instructions if you wish.
+
-
+```bash
-If you would like to default to using the GNU coreutils (recommended), then you
+git clone https://github.com/git-quick-stats/git-quick-stats.git && cd git-quick-stats
-can add `export PATH="$HOMEBREW_PREFIX/opt/coreutils/libexec/gnubin:$PATH"` to
+sudo make install
-your applicable `~/.bash_profile`, `~/.zprofile`, or other relevant profile
+```
-based on the shell of your choice.
+
-
+For uninstalling, open up the cloned directory and run
-### Windows
+
-
+```bash
-If you are installing with Cygwin, use these scripts:
+sudo make uninstall
-
+```
-* [installer](https://gist.github.com/arzzen/35e09866dfdadf2108b2420045739245)
+
-* [uninstaller](https://gist.github.com/arzzen/21c660014d0663b6c5710014714779d6)
+For update/reinstall
-
+
-If you are wishing to use this with WSL, follow the UNIX and Linux instructions.
+```bash
-
+sudo make reinstall
-### Docker
+```
-
+
-You can use the Docker image provided:
+### macOS (homebrew)
-
+
-* Build: `docker build -t arzzen/git-quick-stats .`
+macOS requires GNU coreutils to be installed and for the non "g" aliased
-* Run interactive menu: `docker run --rm -it -v $(pwd):/git arzzen/git-quick-stats`
+versions to be exported to your path. The following is an example of how to
-* Docker pull command: `docker pull arzzen/git-quick-stats` [docker repository](https://hub.docker.com/r/arzzen/git-quick-stats)
+perform this if you are using Homebrew as your package manager.
-
+
-## System requirements
+```bash
-
+brew install coreutils
-* An OS with a Bash shell
+export PATH="$HOMEBREW_PREFIX/opt/coreutils/libexec/gnubin:$PATH"
-* Tools we use:
+```
-
+
-```bash
+From there, you can install via Homebrew as follows:
-awk
+
-basename
+```bash
-cat
+brew install git-quick-stats
-column
+```
-date
+
-echo
+Or you can follow the UNIX and Linux instructions if you wish.
-git
+
-grep
+If you would like to default to using the GNU coreutils (recommended), then you
-head
+can add `export PATH="$HOMEBREW_PREFIX/opt/coreutils/libexec/gnubin:$PATH"` to
-printf
+your applicable `~/.bash_profile`, `~/.zprofile`, or other relevant profile
-seq
+based on the shell of your choice.
-sort
+
-tput
+### Windows
-tr
+
-uniq
+If you are installing with Cygwin, use these scripts:
-```
+
-
+- [installer](https://gist.github.com/arzzen/35e09866dfdadf2108b2420045739245)
-### Dependencies
+- [uninstaller](https://gist.github.com/arzzen/21c660014d0663b6c5710014714779d6)
-
+
-* [`bsdextrautils`](https://packages.debian.org/sid/bsdextrautils) `apt install bsdextrautils`
+If you are wishing to use this with WSL, follow the UNIX and Linux instructions.
-* [`coreutils`](https://packages.debian.org/sid/coreutils) `apt install coreutils`
+
-* [`gawk`](https://packages.debian.org/sid/gawk) `apt install gawk`
+### Docker
-* [`grep`](https://packages.debian.org/sid/grep) `apt install grep`
+
-* [`ncurses-bin`](https://packages.debian.org/sid/ncurses-bin) `apt install ncurses-bin`
+You can use the Docker image provided:
-
+
-## FAQ
+- Build: `docker build -t arzzen/git-quick-stats .`
-
+- Run interactive menu: `docker run --rm -it -v $(pwd):/git arzzen/git-quick-stats`
-*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`
+- Docker pull command: `docker pull arzzen/git-quick-stats` [docker repository](https://hub.docker.com/r/arzzen/git-quick-stats)
-
+
-*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.
+## System requirements
-
+
-*Q:* How they could be used in a project with many git projects and statistics would show a summary of all git projects?
+- An OS with a Bash shell
-
+- Tools we use:
-*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](https://git-scm.com/docs/git-log#Documentation/git-log.txt---submoduleltformatgt))
+```bash
-
+awk
-## Contribution
+basename
-
+cat
-Want to contribute? Great! First, read this page.
+column
-
+date
-### Code reviews
+echo
-
+git
-All submissions, including submissions by project members, require review.</br>
+grep
-We use GitHub pull requests for this purpose.
+head
-
+printf
-### Some tips for good pull requests
+seq
-
+sort
-* Use our code </br>
+tput
-  When in doubt, try to stay true to the existing code of the project.
+tr
-* Write a descriptive commit message. What problem are you solving and what
+uniq
-  are the consequences? Where and what did you test? Some good tips:
+```
-  [here](http://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message)
+
-  and [here](https://www.kernel.org/doc/Documentation/SubmittingPatches).
+### Dependencies
-* If your PR consists of multiple commits which are successive improvements /
+
-  fixes to your first commit, consider squashing them into a single commit
+- [`bsdextrautils`](https://packages.debian.org/sid/bsdextrautils) `apt install bsdextrautils`
-  (`git rebase -i`) such that your PR is a single commit on top of the current
+- [`coreutils`](https://packages.debian.org/sid/coreutils) `apt install coreutils`
-  HEAD. This make reviewing the code so much easier, and our history more
+- [`gawk`](https://packages.debian.org/sid/gawk) `apt install gawk`
-  readable.
+- [`grep`](https://packages.debian.org/sid/grep) `apt install grep`
-
+- [`ncurses-bin`](https://packages.debian.org/sid/ncurses-bin) `apt install ncurses-bin`
-### Formatting
+
-
+## FAQ
-This documentation is written using standard [markdown syntax](https://help.github.com/articles/markdown-basics/). Please submit your changes using the same syntax.
+
-
+_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`
-## Tests
+
-
+_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.
-[![codecov](https://codecov.io/gh/arzzen/git-quick-stats/branch/master/graph/badge.svg)](https://codecov.io/gh/arzzen/git-quick-stats)
+
-
+_Q:_ How they could be used in a project with many git projects and statistics would show a summary of all git projects?
-```bash
+
-make test
+_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](https://git-scm.com/docs/git-log#Documentation/git-log.txt---submoduleltformatgt))
-
+
-## Licensing
+## Contribution
-
+
-MIT see [LICENSE][] for the full license text.
+Want to contribute? Great! First, read this page.
-
+
-   [read this page]: http://github.com/arzzen/git-quick-stats/blob/master/.github/CONTRIBUTING.md
+### Code reviews
-   [landing page]: http://arzzen.github.io/git-quick-stats
+
-   [LICENSE]: https://github.com/arzzen/git-quick-stats/blob/master/LICENSE
+All submissions, including submissions by project members, require review.</br>
-
+We use GitHub pull requests for this purpose.
-## Contributors
+
-
+### Some tips for good pull requests
-This project exists thanks to all the people who contribute.
+
-
+- Use our code </br>
-[![contributors](https://opencollective.com/git-quick-stats/contributors.svg?width=890&button=false)](https://github.com/arzzen/git-quick-stats/graphs/contributors)
+  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
-### Backers
+  are the consequences? Where and what did you test? Some good tips:
-
+  [here](http://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message)
-Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/git-quick-stats#backer)]
+  and [here](https://www.kernel.org/doc/Documentation/SubmittingPatches).
-
+- If your PR consists of multiple commits which are successive improvements /
-[![backers](https://opencollective.com/git-quick-stats/backers.svg?width=890)](https://opencollective.com/git-quick-stats#backers)
+  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
-### Sponsors
+  HEAD. This make reviewing the code so much easier, and our history more
-
+  readable.
-Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/git-quick-stats#sponsor)]
+
-
+### Formatting
-[![sponsor0](https://opencollective.com/git-quick-stats/sponsor/0/avatar.svg?v=1)](https://opencollective.com/git-quick-stats/sponsor/0/website)
+
-[![sponsor1](https://opencollective.com/git-quick-stats/sponsor/1/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/1/website)
+This documentation is written using standard [markdown syntax](https://help.github.com/articles/markdown-basics/). Please submit your changes using the same syntax.
-[![sponsor2](https://opencollective.com/git-quick-stats/sponsor/2/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/2/website)
+
-[![sponsor3](https://opencollective.com/git-quick-stats/sponsor/3/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/3/website)
+## Tests
-[![sponsor4](https://opencollective.com/git-quick-stats/sponsor/4/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/4/website)
+
-[![sponsor5](https://opencollective.com/git-quick-stats/sponsor/5/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/5/website)
+[![codecov](https://codecov.io/gh/arzzen/git-quick-stats/branch/master/graph/badge.svg)](https://codecov.io/gh/arzzen/git-quick-stats)
-[![sponsor6](https://opencollective.com/git-quick-stats/sponsor/6/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/6/website)
+
-[![sponsor7](https://opencollective.com/git-quick-stats/sponsor/7/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/7/website)
+```bash
-[![sponsor8](https://opencollective.com/git-quick-stats/sponsor/8/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/8/website)
+make test
-[![sponsor9](https://opencollective.com/git-quick-stats/sponsor/9/avatar.svg)](https://opencollective.com/git-quick-stats/sponsor/9/website)
+```
+
+## Licensing
+
+MIT see [LICENSE][] for the full license text.
+
+[read this page]: http://github.com/git-quick-stats/git-quick-stats/blob/master/.github/CONTRIBUTING.md
+[landing page]: https://git-quick-stats.sh
+[LICENSE]: https://github.com/git-quick-stats/git-quick-stats/blob/master/LICENSE
+
+## Contributors
+
+This project exists thanks to all the people who contribute.
+
+[![contributors](https://opencollective.com/git-quick-stats/contributors.svg?width=890&button=false)](https://github.com/git-quick-stats/git-quick-stats/graphs/contributors)

git-quick-stats.1

@@ -1,171 +1,206 @@
-.TH git-quick-stats "1" "April 2024" "git-quick-stats" "User Commands"
+.TH git-quick-stats "1" "June 2025" "git-quick-stats" "User Commands"
-.SH NAME
+.SH NAME
-.B git\-quick\-stats
+.B git\-quick\-stats
-\- Simple and efficient way to access various stats in a git repository.
+\- Simple and efficient way to access various stats in a git repository.
-.SH SYNOPSIS
+.SH SYNOPSIS
-.PP
+.PP
-For non\-interactive mode:
+For non\-interactive mode:
-.B git\-quick\-stats [OPTIONS]
+.B git\-quick\-stats [OPTIONS]
-.PP
+.PP
-For interactive mode:
+For interactive mode:
-.B git-quick-stats
+.B git-quick-stats
-.PP
+.PP
-.SH DESCRIPTION
+.SH DESCRIPTION
-.PP
+.PP
-Any git repository contains tons of information about commits, contributors,
+Any git repository contains tons of information about commits, contributors,
-and files. Extracting this information is not always trivial, mostly because
+and files. Extracting this information is not always trivial, mostly because
-of a gadzillion options to a gadzillion git commands.
+of a gadzillion options to a gadzillion git commands.
-This program allows you to see detailed information about a git repository.
+This program allows you to see detailed information about a git repository.
-.PP
+.PP
-.SH GENERATE OPTIONS
+.SH GENERATE OPTIONS
-.PP
+.PP
-\fB\-T\fR, \fB\-\-detailed\-git\-stats\fR
+\fB\-h\fR, \-?, \fB\-\-help\fR
-.IP
+.IP
-give a detailed list of git stats
+display this help text in the terminal
-.HP
+.PP
-.PP
+\fB\-T\fR, \fB\-\-detailed\-git\-stats\fR
-\fB\-R\fR, \fB\-\-git\-stats\-by\-branch\fR
+.IP
-.IP
+give a detailed list of git stats
-see detailed list of git stats by branch
+.HP
-.HP
+.PP
-.PP
+\fB\-R\fR, \fB\-\-git\-stats\-by\-branch\fR
-\fB\-c\fR, \fB\-\-changelogs\fR
+.IP
-.IP
+see detailed list of git stats by branch
-see changelogs
+.HP
-.HP
+.PP
-.PP
+\fB\-c\fR, \fB\-\-changelogs\fR
-\fB\-L\fR, \fB\-\-changelogs\-by\-author\fR
+.IP
-.IP
+see changelogs
-see changelogs by author
+.HP
-.HP
+.PP
-.PP
+\fB\-L\fR, \fB\-\-changelogs\-by\-author\fR
-\fB\-S\fR, \fB\-\-my\-daily\-stats\fR
+.IP
-.IP
+see changelogs by author
-see your current daily stats
+.HP
-.HP
+.PP
-.PP
+\fB\-S\fR, \fB\-\-my\-daily\-stats\fR
-\fB\-V\fR, \fB\-\-csv\-output\-by\-branch\fR
+.IP
-.IP
+see your current daily stats
-output daily stats by branch in CSV format
+.HP
-.HP
+.PP
-.PP
+\fB\-V\fR, \fB\-\-csv\-output\-by\-branch\fR
-\fB\-j\fR, \fB\-\-json\-output\fR
+.IP
-.IP
+output daily stats by branch in CSV format
-save git log as a JSON formatted file to a specified area
+.HP
-.HP
+.PP
-.SH LIST OPTIONS
+\fB\-j\fR, \fB\-\-json\-output\fR
-.PP
+.IP
-\fB\-b\fR, \fB\-\-branch\-tree\fR
+save git log as a JSON formatted file to a specified area
-.IP
+.HP
-show an ASCII graph of the git repo branch history
+.SH LIST OPTIONS
-.HP
+.PP
-.PP
+\fB\-b\fR, \fB\-\-branch\-tree\fR
-\fB\-D\fR, \fB\-\-branches\-by\-date\fR
+.IP
-.IP
+show an ASCII graph of the git repo branch history
-show branches by date
+.HP
-.HP
+.PP
-.PP
+\fB\-D\fR, \fB\-\-branches\-by\-date\fR
-\fB\-C\fR, \fB\-\-contributors\fR
+.IP
-.IP
+show branches by date
-see a list of everyone who contributed to the repo
+.HP
-.HP
+.PP
-.PP
+\fB\-C\fR, \fB\-\-contributors\fR
-\fB\-n\fR, \fB\-\-new\-contributors\fR
+.IP
-.IP
+see a list of everyone who contributed to the repo
-list everyone who made their first contribution since a specified date
+.HP
-.HP
+.PP
-.PP
+\fB\-n\fR, \fB\-\-new\-contributors\fR
-\fB\-a\fR, \fB\-\-commits\-per\-author\fR
+.IP
-.IP
+list everyone who made their first contribution since a specified date
-displays a list of commits per author
+.HP
-.HP
+.PP
-.PP
+\fB\-a\fR, \fB\-\-commits\-per\-author\fR
-\fB\-d\fR, \fB\-\-commits\-per\-day\fR
+.IP
-.IP
+displays a list of commits per author
-displays a list of commits per day
+.HP
-.HP
+.PP
-.PP
+\fB\-d\fR, \fB\-\-commits\-per\-day\fR
-\fB\-m\fR, \fB\-\-commits\-by\-month\fR
+.IP
-.IP
+displays a list of commits per day
-displays a list of commits per month
+.HP
-.HP
+.PP
-.PP
+\fB\-m\fR, \fB\-\-commits\-by\-month\fR
-\fB\-Y\fR, \fB\-\-commits\-by\-year\fR
+.IP
-.IP
+displays a list of commits per month
-displays a list of commits per year
+.HP
-.HP
+.PP
-.PP
+\fB\-Y\fR, \fB\-\-commits\-by\-year\fR
-\fB\-w\fR, \fB\-\-commits\-by\-weekday\fR
+.IP
-.IP
+displays a list of commits per year
-displays a list of commits per weekday
+.HP
-.HP
+.PP
-.PP
+\fB\-w\fR, \fB\-\-commits\-by\-weekday\fR
-\fB\-W\fR, \fB\-\-commits\-by\-author\-by\-weekday\fR
+.IP
-.IP
+displays a list of commits per weekday
-displays a list of commits per weekday by author
+.HP
-.HP
+.PP
-.PP
+\fB\-W\fR, \fB\-\-commits\-by\-author\-by\-weekday\fR
-\fB\-o\fR, \fB\-\-commits\-by\-hour\fR
+.IP
-.IP
+displays a list of commits per weekday by author
-displays a list of commits per hour
+.HP
-.HP
+.PP
-.PP
+\fB\-o\fR, \fB\-\-commits\-by\-hour\fR
-\fB\-A\fR, \fB\-\-commits\-by\-author\-by\-hour\fR
+.IP
-.IP
+displays a list of commits per hour
-displays a list of commits per hour by author
+.HP
-.HP
+.PP
-.PP
+\fB\-A\fR, \fB\-\-commits\-by\-author\-by\-hour\fR
-\fB\-z\fR, \fB\-\-commits\-by\-timezone\fR
+.IP
-.IP
+displays a list of commits per hour by author
-displays a list of commits per timezone
+.HP
-.HP
+.PP
-.PP
+\fB\-z\fR, \fB\-\-commits\-by\-timezone\fR
-\fB\-Z\fR, \fB\-\-commits\-by\-author\-by\-timezone\fR
+.IP
-.IP
+displays a list of commits per timezone
-displays a list of commits per timezone by author
+.HP
-.HP
+.PP
-.SH SUGGEST OPTIONS
+\fB\-Z\fR, \fB\-\-commits\-by\-author\-by\-timezone\fR
-.PP
+.IP
-\fB\-r\fR, \fB\-\-suggest\-reviewers\fR
+displays a list of commits per timezone by author
-.IP
+.HP
-show the best people to contact to review code
+.PP
-.HP
+\fB\-\-activity\-calendar\fR
-.PP
+.IP
-\fB\-h\fR, \-?, \fB\-\-help\fR
+displays a calendar-style grid of commit activity per day-of-week and month for a selected author.
-.IP
+.HP
-display this help text in the terminal
+.SH SUGGEST OPTIONS
-.PP
+.PP
-.SH ADDITIONAL USAGE
+\fB\-r\fR, \fB\-\-suggest\-reviewers\fR
-You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log, example:
+.IP
-.PP
+show the best people to contact to review code
-.B  export _GIT_SINCE="2017\-01\-20"
+.HP
-.PP
+.PP
-You can set _GIT_LIMIT for limited output log, example:
+.SH CALENDAR OPTIONS
-.PP
+.PP
-.B  export _GIT_LIMIT=20
+\fB\-k\fR, \fB\-\-commits\-calendar\-by\-author\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
+.PP
-You can set _GIT_LOG_OPTIONS for git log options, example:
+.PP
-.PP
+\fB\-H\fR, \fB\-\-commits\-heatmap\fR shows a heatmap of commits per day per hour for the last 30 days
-.B  export _GIT_LOG_OPTIONS="--ignore-all-space --ignore-blank-lines"
+.PP
-.PP
+.SH ADDITIONAL USAGE
-You can exclude directories or files from the stats by using pathspec, example:
+You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log, example:
-.PP
+.PP
-.B export _GIT_PATHSPEC=':!pattern'
+.B  export _GIT_SINCE="2017\-01\-20"
-.PP
+.PP
-You can set _GIT_MERGE_VIEW to show merge commits with normal commits, example:
+You can set _GIT_LIMIT for limited output log, example:
-.PP
+.PP
-.B  export _GIT_MERGE_VIEW="enable"
+.B  export _GIT_LIMIT=20
-.PP
+.PP
-You can also set _GIT_MERGE_VIEW to only show merge commits, example:
+You can set _GIT_LOG_OPTIONS for git log options, example:
-.PP
+.PP
-.B  export _GIT_MERGE_VIEW="exclusive"
+.B  export _GIT_LOG_OPTIONS="--ignore-all-space --ignore-blank-lines"
-.PP
+.PP
-You can switch to the legacy color scheme, example:
+You can exclude directories or files from the stats by using pathspec, example:
-.PP
+.PP
-.B export _MENU_THEME=legacy
+.B export _GIT_PATHSPEC=':!pattern'
-.PP
+.PP
-You can set _GIT_BRANCH to set the branch of the stats, example:
+You can set _GIT_MERGE_VIEW to show merge commits with normal commits, example:
-.PP
+.PP
-.B  export _GIT_BRANCH="master"
+.B  export _GIT_MERGE_VIEW="enable"
-.
+.PP
-.fi
+You can also set _GIT_MERGE_VIEW to only show merge commits, example:
+.PP
+.B  export _GIT_MERGE_VIEW="exclusive"
+.PP
+You can sort contribution stats by field "name", "commits", "insertions", "deletions", or "lines" (total lines changed) and order ("asc", "desc"). e.g.: "commits-desc"
+.PP
+.B  export _GIT_SORT_BY="name-asc"
+.PP
+You can change to the legacy color scheme by toggling the variable "_MENU_THEME" between "default" and "legacy". You can completely disable the color theme by setting the "_MENU_THEME" variable to "none", example:
+.PP
+.B export _MENU_THEME=legacy
+.PP
+or
+.B export _MENU_THEME=none
+.PP
+You can set _GIT_BRANCH to set the branch of the stats, example:
+.PP
+.B  export _GIT_BRANCH="master"
+.PP
+You can set _GIT_IGNORE_AUTHORS to filter out specific authors, example:
+.PP
+.B  export _GIT_IGNORE_AUTHORS="(author@examle.com|username)"
+.PP
+You can set _GIT_DAYS to set the number of days for the heatmap, example:
+.PP
+.B  export _GIT_DAYS=30"
+.
+.fi
+
+.PP
+.SH SEE ALSO
+.BR git (1)
+.PP
+Project homepage:
+.UR https://github.com/git-quick-stats/git-quick-stats
+.UE

tests/commands_test.sh

@@ -11,7 +11,7 @@
 . tests/assert.sh -v
 
 src="./git-quick-stats"
-assert "$src fail" "Invalid argument
+assert "$src fail" "Invalid argument: fail
 
 NAME
     git-quick-stats - Simple and efficient way to access various stats in a git repo
@@ -24,7 +24,7 @@ DESCRIPTION
     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.
 
 GENERATE OPTIONS
@@ -73,6 +73,12 @@ LIST OPTIONS
     -Z, --commits-by-author-by-timezone
         displays a list of commits per timezone by author
 
+CALENDAR OPTIONS
+    -k, --commits-calendar-by-author
+        shows a calendar heatmap of commits per day-of-week per month for a given author
+    -H, --commits-heatmap
+        shows a heatmap of commits per day-of-week per month for the last 30 days
+
 SUGGEST OPTIONS
     -r, --suggest-reviewers
         show the best people to contact to review code
@@ -92,17 +98,24 @@ ADDITIONAL USAGE
         ex: export _GIT_MERGE_VIEW=enable
     You can also set _GIT_MERGE_VIEW to only show merge commits
         ex: export _GIT_MERGE_VIEW=exclusive
-    You can set _MENU_THEME to display the legacy color scheme
+    You can change to the legacy color scheme by toggling the variable \"_MENU_THEME\" between \"default\" and \"legacy\".
+    You can completely disable the color theme by setting the \"_MENU_THEME\" variable to \"none\".
         ex: export _MENU_THEME=legacy
     You can set _GIT_BRANCH to set the branch of the stats
-        ex: export _GIT_BRANCH=master"
+        ex: export _GIT_BRANCH=master
+    You can set _GIT_IGNORE_AUTHORS to filter out specific authors
+        ex: export _GIT_IGNORE_AUTHORS=\"(author1|author2)\"
+    You can sort contribution stats by field \"name\", \"commits\", \"insertions\", \"deletions\", or \"lines\" - total lines changed and order - \"asc\", \"desc\"
+        ex: export _GIT_SORT_BY=\"name-asc\"
+    You can set _GIT_DAYS to set the number of days for the heatmap
+        ex: export _GIT_DAYS=30"
 
 assert_raises "$src fail" 1
 
 assert_contains "$src --suggest-reviewers" "Suggested code reviewers (based on git history)"
 assert_success "$src --suggest-reviewers"
 
-assert_contains "$src --detailed-git-stats" "Contribution stats"
+assert_contains "$src --detailed-git-stats" "Contribution stats (by author) on the current branch"
 assert_success "$src --detailed-git-stats"
 
 assert_contains "$src --commits-per-day" "Git commits per date"