mirror of
https://github.com/arzzen/git-quick-stats.git
synced 2026-09-11 08:06:18 -04:00
Compare commits
No commits in common. "master" and "2.4.0" have entirely different histories.
5
.github/FUNDING.yml
vendored
5
.github/FUNDING.yml
vendored
|
|
@ -1 +1,6 @@
|
||||||
# These are supported funding model platforms
|
# These are supported funding model platforms
|
||||||
|
|
||||||
|
github: [arzzen]
|
||||||
|
open_collective: git-quick-stats
|
||||||
|
ko_fi: lukasmestan
|
||||||
|
custom: ['https://lukasmestan.com/thanks/']
|
||||||
|
|
|
||||||
5
.gitignore
vendored
5
.gitignore
vendored
|
|
@ -7,7 +7,4 @@
|
||||||
.Spotlight*
|
.Spotlight*
|
||||||
.Trash*
|
.Trash*
|
||||||
**/*~
|
**/*~
|
||||||
nbproject/*
|
nbproject/*
|
||||||
/tests/test-git/.git/
|
|
||||||
#/tests/test-git/*
|
|
||||||
!/tests/test-git/resetgit
|
|
||||||
4
.mailmap
4
.mailmap
|
|
@ -1,3 +1,3 @@
|
||||||
Lukas <test@gmail.com> Lukáš <arzzen@users.noreply.github.com>
|
Lukas Mestan <lukas.mestan@gmail.com> Lukáš Mešťan <arzzen@users.noreply.github.com>
|
||||||
Lukas <lukas@gmail.com> arzzen
|
Lukas Mestan <lukas.mestan@gmail.com> arzzen
|
||||||
|
|
||||||
|
|
|
||||||
25
CITATION.cff
25
CITATION.cff
|
|
@ -1,25 +0,0 @@
|
||||||
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
|
|
||||||
|
|
@ -4,7 +4,7 @@ FROM alpine
|
||||||
COPY . /app
|
COPY . /app
|
||||||
|
|
||||||
# Install required packages & build git-quick-stats
|
# Install required packages & build git-quick-stats
|
||||||
RUN apk add --no-cache bash git make ncurses coreutils util-linux \
|
RUN apk add --no-cache bash git make ncurses util-linux \
|
||||||
&& cd /app \
|
&& cd /app \
|
||||||
&& make install \
|
&& make install \
|
||||||
&& rm -rf /app \
|
&& rm -rf /app \
|
||||||
|
|
@ -23,6 +23,5 @@ ENV _GIT_SINCE= \
|
||||||
TERM=xterm-256color
|
TERM=xterm-256color
|
||||||
|
|
||||||
WORKDIR /git
|
WORKDIR /git
|
||||||
RUN git config --global --add safe.directory /git
|
|
||||||
ENTRYPOINT [ "/usr/local/bin/docker-entrypoint" ]
|
ENTRYPOINT [ "/usr/local/bin/docker-entrypoint" ]
|
||||||
CMD [ "/usr/bin/git", "quick-stats" ]
|
CMD [ "/usr/bin/git", "quick-stats" ]
|
||||||
2
LICENSE
2
LICENSE
|
|
@ -1,6 +1,6 @@
|
||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) 2024 git-quick-stats.sh
|
Copyright (c) 2021 Lukáš Mešťan
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|
|
||||||
4
Makefile
4
Makefile
|
|
@ -30,8 +30,8 @@ uninstall:
|
||||||
@$(TASK_DONE)
|
@$(TASK_DONE)
|
||||||
|
|
||||||
reinstall:
|
reinstall:
|
||||||
@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
|
||||||
@curl -sO https://raw.githubusercontent.com/git-quick-stats/git-quick-stats/master/git-quick-stats.1
|
@curl -sO https://raw.githubusercontent.com/arzzen/git-quick-stats/master/git-quick-stats.1
|
||||||
$(MAKE) install
|
$(MAKE) install
|
||||||
@$(TASK_DONE)
|
@$(TASK_DONE)
|
||||||
|
|
||||||
|
|
|
||||||
808
README.md
808
README.md
|
|
@ -1,433 +1,375 @@
|
||||||
# GIT quick statistics [](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 [](#backers) [](#sponsors) [](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) [](https://travis-ci.org/arzzen/git-quick-stats) [](https://formulae.brew.sh/formula/git-quick-stats#default) [](https://repology.org/metapackage/git-quick-stats/packages)
|
||||||
[](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 :).
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 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
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
## Usage
|
### Interactive
|
||||||
|
|
||||||
### Interactive
|
`git-quick-stats` has a built-in interactive menu that can be executed as such:
|
||||||
|
|
||||||
`git-quick-stats` has a built-in interactive menu that can be executed as such:
|
```bash
|
||||||
|
git-quick-stats
|
||||||
```bash
|
```
|
||||||
git-quick-stats
|
|
||||||
```
|
Or
|
||||||
|
|
||||||
Or
|
```bash
|
||||||
|
git quick-stats
|
||||||
```bash
|
```
|
||||||
git quick-stats
|
|
||||||
```
|
### Non-interactive
|
||||||
|
|
||||||
### 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:
|
||||||
|
|
||||||
For those who prefer to utilize command-line options, `git-quick-stats` also has a non-interactive mode supporting both short and long options:
|
```bash
|
||||||
|
git-quick-stats <optional-command-to-execute-directly>
|
||||||
```bash
|
```
|
||||||
git-quick-stats <optional-command-to-execute-directly>
|
|
||||||
```
|
Or
|
||||||
|
|
||||||
Or
|
```bash
|
||||||
|
git quick-stats <optional-command-to-execute-directly>
|
||||||
```bash
|
```
|
||||||
git quick-stats <optional-command-to-execute-directly>
|
|
||||||
```
|
### Command-line arguments
|
||||||
|
|
||||||
### Command-line arguments
|
Possible arguments in short and long form:
|
||||||
|
|
||||||
Possible arguments in short and long form:
|
```bash
|
||||||
|
GENERATE OPTIONS
|
||||||
```bash
|
-T, --detailed-git-stats
|
||||||
GENERATE OPTIONS
|
give a detailed list of git stats
|
||||||
-T, --detailed-git-stats
|
-R, --git-stats-by-branch
|
||||||
give a detailed list of git stats
|
see detailed list of git stats by branch
|
||||||
-R, --git-stats-by-branch
|
-c, --changelogs
|
||||||
see detailed list of git stats by branch
|
see changelogs
|
||||||
-c, --changelogs
|
-L, --changelogs-by-author
|
||||||
see changelogs
|
see changelogs by author
|
||||||
-L, --changelogs-by-author
|
-S, --my-daily-stats
|
||||||
see changelogs by author
|
see your current daily stats
|
||||||
-S, --my-daily-stats
|
-V, --csv-output-by-branch
|
||||||
see your current daily stats
|
output daily stats by branch in CSV format
|
||||||
-V, --csv-output-by-branch
|
-j, --json-output
|
||||||
output daily stats by branch in CSV format
|
save git log as a JSON formatted file to a specified area
|
||||||
-j, --json-output
|
|
||||||
save git log as a JSON formatted file to a specified area
|
LIST OPTIONS
|
||||||
|
-b, --branch-tree
|
||||||
LIST OPTIONS
|
show an ASCII graph of the git repo branch history
|
||||||
-b, --branch-tree
|
-D, --branches-by-date
|
||||||
show an ASCII graph of the git repo branch history
|
show branches by date
|
||||||
-D, --branches-by-date
|
-C, --contributors
|
||||||
show branches by date
|
see a list of everyone who contributed to the repo
|
||||||
-C, --contributors
|
-a, --commits-per-author
|
||||||
see a list of everyone who contributed to the repo
|
displays a list of commits per author
|
||||||
-n, --new-contributors
|
-d, --commits-per-day
|
||||||
list everyone who made their first contribution since a specified date
|
displays a list of commits per day
|
||||||
-N, --new-contributors-since-tag
|
-Y, --commits-by-year
|
||||||
list everyone who made their first contribution since a specified git tag
|
displays a list of commits per year
|
||||||
-a, --commits-per-author
|
-m, --commits-by-month
|
||||||
displays a list of commits per author
|
displays a list of commits per month
|
||||||
-d, --commits-per-day
|
-w, --commits-by-weekday
|
||||||
displays a list of commits per day
|
displays a list of commits per weekday
|
||||||
-m, --commits-by-month
|
-o, --commits-by-hour
|
||||||
displays a list of commits per month
|
displays a list of commits per hour
|
||||||
-Y, --commits-by-year
|
-A, --commits-by-author-by-hour
|
||||||
displays a list of commits per year
|
displays a list of commits per hour by author
|
||||||
-w, --commits-by-weekday
|
-z, --commits-by-timezone
|
||||||
displays a list of commits per weekday
|
displays a list of commits per timezone
|
||||||
-W, --commits-by-author-by-weekday
|
-Z, --commits-by-author-by-timezone
|
||||||
displays a list of commits per weekday by author
|
displays a list of commits per timezone by author
|
||||||
-o, --commits-by-hour
|
|
||||||
displays a list of commits per hour
|
SUGGEST OPTIONS
|
||||||
-A, --commits-by-author-by-hour
|
-r, --suggest-reviewers
|
||||||
displays a list of commits per hour by author
|
show the best people to contact to review code
|
||||||
-z, --commits-by-timezone
|
-h, -?, --help
|
||||||
displays a list of commits per timezone
|
display this help text in the terminal
|
||||||
-Z, --commits-by-author-by-timezone
|
```
|
||||||
displays a list of commits per timezone by author
|
|
||||||
|
### Git log since and until
|
||||||
CALENDAR OPTIONS
|
|
||||||
-k, --commits-calendar-by-author
|
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.
|
||||||
shows a calendar heatmap of commits per day-of-week per month for a given author
|
|
||||||
-H, --commits-heatmap
|
```bash
|
||||||
shows a heatmap of commits per day-of-week per month for the last 30 days
|
export _GIT_SINCE="2017-01-20"
|
||||||
|
export _GIT_UNTIL="2017-01-22"
|
||||||
SUGGEST OPTIONS
|
```
|
||||||
-r, --suggest-reviewers
|
|
||||||
show the best people to contact to review code
|
Once set, run `git quick-stats` as normal. Note that this affects all stats that parse the git log history until unset.
|
||||||
-h, -?, --help
|
|
||||||
display this help text in the terminal
|
### Git log limit
|
||||||
```
|
|
||||||
|
You can set variable `_GIT_LIMIT` for limited output. It will affect the "changelogs" and "branch tree" options.
|
||||||
### Git log since and until
|
|
||||||
|
```bash
|
||||||
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.
|
export _GIT_LIMIT=20
|
||||||
|
```
|
||||||
```bash
|
|
||||||
export _GIT_SINCE="2017-01-20"
|
### Git log options
|
||||||
export _GIT_UNTIL="2017-01-22"
|
|
||||||
```
|
You can set `_GIT_LOG_OPTIONS` for [git log options](https://git-scm.com/docs/git-log#_options):
|
||||||
|
|
||||||
Once set, run `git quick-stats` as normal. Note that this affects all stats that parse the git log history until unset.
|
```bash
|
||||||
|
export _GIT_LOG_OPTIONS="--ignore-all-space --ignore-blank-lines"
|
||||||
### Git log limit
|
```
|
||||||
|
|
||||||
You can set variable `_GIT_LIMIT` for limited output. It will affect the "changelogs" and "branch tree" options. The default limit is `10`.
|
### Git pathspec
|
||||||
|
|
||||||
```bash
|
You can exclude a directory from the stats by using [pathspec](https://git-scm.com/docs/gitglossary#gitglossary-aiddefpathspecapathspec)
|
||||||
export _GIT_LIMIT=20
|
|
||||||
```
|
```bash
|
||||||
|
export _GIT_PATHSPEC=':!directory'
|
||||||
### Git tag
|
```
|
||||||
|
|
||||||
You can set `_GIT_TAG` to define the default tag used by the "new contributors since tag" option.
|
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_TAG="foo"
|
export _GIT_PATHSPEC=':!package-lock.json'
|
||||||
```
|
```
|
||||||
|
|
||||||
### Git log options
|
### Git merge view strategy
|
||||||
|
|
||||||
You can set `_GIT_LOG_OPTIONS` for [git log options](https://git-scm.com/docs/git-log#_options):
|
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.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
export _GIT_LOG_OPTIONS="--ignore-all-space --ignore-blank-lines"
|
export _GIT_MERGE_VIEW="enable"
|
||||||
```
|
export _GIT_MERGE_VIEW="exclusive"
|
||||||
|
```
|
||||||
### Git pathspec
|
|
||||||
|
### Git branch
|
||||||
You can exclude a directory from the stats by using [pathspec](https://git-scm.com/docs/gitglossary#gitglossary-aiddefpathspecapathspec)
|
|
||||||
|
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
|
|
||||||
export _GIT_PATHSPEC=':!directory'
|
```bash
|
||||||
```
|
export _GIT_BRANCH="master"
|
||||||
|
```
|
||||||
You can also exclude files from the stats. Note that it works with any alphanumeric, glob, or regex that git respects.
|
|
||||||
|
### Color themes
|
||||||
```bash
|
|
||||||
export _GIT_PATHSPEC=':!package-lock.json'
|
You can change to the legacy color scheme by toggling the variable `_MENU_THEME` between `default` and `legacy`
|
||||||
```
|
|
||||||
|
```bash
|
||||||
### Git merge view strategy
|
export _MENU_THEME="legacy"
|
||||||
|
```
|
||||||
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.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
export _GIT_MERGE_VIEW="enable"
|
## Installation
|
||||||
export _GIT_MERGE_VIEW="exclusive"
|
|
||||||
```
|
### Debian and Ubuntu
|
||||||
|
|
||||||
### Git branch
|
If you are on at least Debian Bullseye or Ubuntu Focal you can use apt for installation:
|
||||||
|
|
||||||
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
|
||||||
|
apt install git-quick-stats
|
||||||
```bash
|
```
|
||||||
export _GIT_BRANCH="master"
|
|
||||||
```
|
### UNIX and Linux
|
||||||
|
|
||||||
### Ignore authors
|
```bash
|
||||||
|
git clone https://github.com/arzzen/git-quick-stats.git && cd git-quick-stats
|
||||||
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.
|
sudo make install
|
||||||
|
```
|
||||||
```bash
|
|
||||||
export _GIT_IGNORE_AUTHORS="(author@examle.com|username)"
|
For uninstalling, open up the cloned directory and run
|
||||||
```
|
|
||||||
|
```bash
|
||||||
### Sorting contribution stats
|
sudo make uninstall
|
||||||
|
```
|
||||||
You can sort contribution stats by field `name`, `commits`, `insertions`, `deletions`, or `lines` (total lines changed) and order (`asc`, `desc`). e.g.: `commits-desc`
|
|
||||||
|
For update/reinstall
|
||||||
```bash
|
|
||||||
export _GIT_SORT_BY="name-asc"
|
```bash
|
||||||
```
|
sudo make reinstall
|
||||||
|
```
|
||||||
### Commit days
|
|
||||||
|
### macOS (homebrew)
|
||||||
You can set \_GIT_DAYS to set the number of days for the heatmap
|
|
||||||
|
```bash
|
||||||
```bash
|
brew install git-quick-stats
|
||||||
export _GIT_DAYS=30
|
```
|
||||||
```
|
|
||||||
|
Or you can follow the UNIX and Linux instructions if you wish.
|
||||||
### Color themes
|
|
||||||
|
### Windows
|
||||||
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`.
|
If you are installing with Cygwin, use these scripts:
|
||||||
|
|
||||||
```bash
|
* [installer](https://gist.github.com/arzzen/35e09866dfdadf2108b2420045739245)
|
||||||
export _MENU_THEME="legacy"
|
* [uninstaller](https://gist.github.com/arzzen/21c660014d0663b6c5710014714779d6)
|
||||||
# or
|
|
||||||
export _MENU_THEME="none"
|
If you are wishing to use this with WSL, follow the UNIX and Linux instructions.
|
||||||
```
|
|
||||||
|
### Docker
|
||||||
|
|
||||||
|
You can use the Docker image provided:
|
||||||
## Installation
|
|
||||||
|
* Build: `docker build -t arzzen/git-quick-stats .`
|
||||||
### Debian and Ubuntu
|
* Run interactive menu: `docker run --rm -it -v $(pwd):/git arzzen/git-quick-stats`
|
||||||
|
* Docker pull command: `docker pull arzzen/git-quick-stats` [docker repository](https://hub.docker.com/r/arzzen/git-quick-stats)
|
||||||
If you are on at least Debian Bullseye or Ubuntu Focal you can use apt for installation:
|
|
||||||
|
## System requirements
|
||||||
```bash
|
|
||||||
apt install git-quick-stats
|
* An OS with a Bash shell
|
||||||
```
|
* Tools we use:
|
||||||
|
|
||||||
### UNIX and Linux
|
```bash
|
||||||
|
awk
|
||||||
```bash
|
basename
|
||||||
git clone https://github.com/git-quick-stats/git-quick-stats.git && cd git-quick-stats
|
cat
|
||||||
sudo make install
|
column
|
||||||
```
|
echo
|
||||||
|
git
|
||||||
For uninstalling, open up the cloned directory and run
|
grep
|
||||||
|
head
|
||||||
```bash
|
printf
|
||||||
sudo make uninstall
|
seq
|
||||||
```
|
sort
|
||||||
|
tput
|
||||||
For update/reinstall
|
tr
|
||||||
|
uniq
|
||||||
```bash
|
```
|
||||||
sudo make reinstall
|
|
||||||
```
|
### Dependencies
|
||||||
|
|
||||||
### macOS (homebrew)
|
* [`bsdmainutils`](https://packages.debian.org/sid/bsdmainutils) `apt install bsdmainutils`
|
||||||
|
|
||||||
`git-quick-stats` requires GNU `date`. On macOS, install GNU coreutils:
|
## FAQ
|
||||||
|
|
||||||
```bash
|
*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`
|
||||||
brew install coreutils
|
|
||||||
export PATH="$HOMEBREW_PREFIX/opt/coreutils/libexec/gnubin:$PATH"
|
*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?
|
||||||
The script auto-detects GNU date as either `date` or `gdate`, so exporting
|
|
||||||
`gnubin` is optional for this project.
|
*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))
|
||||||
From there, you can install via Homebrew as follows:
|
|
||||||
|
## Contribution
|
||||||
```bash
|
|
||||||
brew install git-quick-stats
|
Want to contribute? Great! First, read this page.
|
||||||
```
|
|
||||||
|
### Code reviews
|
||||||
Or you can follow the UNIX and Linux instructions if you wish.
|
|
||||||
|
All submissions, including submissions by project members, require review.</br>
|
||||||
If you would like to default to using GNU coreutils system-wide, add
|
We use GitHub pull requests for this purpose.
|
||||||
`export PATH="$HOMEBREW_PREFIX/opt/coreutils/libexec/gnubin:$PATH"` to your
|
|
||||||
applicable `~/.bash_profile`, `~/.zprofile`, or other relevant profile based
|
### Some tips for good pull requests
|
||||||
on the shell of your choice.
|
|
||||||
|
* Use our code </br>
|
||||||
### FreeBSD
|
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
|
||||||
`git-quick-stats` requires GNU `date`. On FreeBSD, install GNU coreutils:
|
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)
|
||||||
```bash
|
and [here](https://www.kernel.org/doc/Documentation/SubmittingPatches).
|
||||||
pkg install coreutils
|
* 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
|
||||||
FreeBSD provides GNU date as `gdate`, and the script auto-detects it.
|
HEAD. This make reviewing the code so much easier, and our history more
|
||||||
|
readable.
|
||||||
### Windows
|
|
||||||
|
### Formatting
|
||||||
If you are installing with Cygwin, use these scripts:
|
|
||||||
|
This documentation is written using standard [markdown syntax](https://help.github.com/articles/markdown-basics/). Please submit your changes using the same syntax.
|
||||||
- [installer](https://gist.github.com/arzzen/35e09866dfdadf2108b2420045739245)
|
|
||||||
- [uninstaller](https://gist.github.com/arzzen/21c660014d0663b6c5710014714779d6)
|
## Tests
|
||||||
|
|
||||||
If you are wishing to use this with WSL, follow the UNIX and Linux instructions.
|
[](https://codecov.io/gh/arzzen/git-quick-stats)
|
||||||
|
|
||||||
### Docker
|
```bash
|
||||||
|
make test
|
||||||
You can use the Docker image provided:
|
```
|
||||||
|
|
||||||
- Build: `docker build -t arzzen/git-quick-stats .`
|
## Licensing
|
||||||
- Run interactive menu: `docker run --rm -it -v $(pwd):/git arzzen/git-quick-stats`
|
|
||||||
- Docker pull command: `docker pull arzzen/git-quick-stats` [docker repository](https://hub.docker.com/r/arzzen/git-quick-stats)
|
MIT see [LICENSE][] for the full license text.
|
||||||
|
|
||||||
## System requirements
|
[read this page]: http://github.com/arzzen/git-quick-stats/blob/master/.github/CONTRIBUTING.md
|
||||||
|
[landing page]: http://arzzen.github.io/git-quick-stats
|
||||||
- An OS with a Bash shell
|
[LICENSE]: https://github.com/arzzen/git-quick-stats/blob/master/LICENSE
|
||||||
- GNU `date` available as either `date` or `gdate`
|
|
||||||
- Tools we use:
|
## Contributors
|
||||||
|
|
||||||
```bash
|
This project exists thanks to all the people who contribute.
|
||||||
awk
|
|
||||||
basename
|
[](https://github.com/arzzen/git-quick-stats/graphs/contributors)
|
||||||
cat
|
|
||||||
column
|
### Backers
|
||||||
date
|
|
||||||
echo
|
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/git-quick-stats#backer)]
|
||||||
git
|
|
||||||
grep
|
[](https://opencollective.com/git-quick-stats#backers)
|
||||||
head
|
|
||||||
printf
|
### Sponsors
|
||||||
seq
|
|
||||||
sort
|
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)]
|
||||||
tput
|
|
||||||
tr
|
[](https://opencollective.com/git-quick-stats/sponsor/0/website)
|
||||||
uniq
|
[](https://opencollective.com/git-quick-stats/sponsor/1/website)
|
||||||
```
|
[](https://opencollective.com/git-quick-stats/sponsor/2/website)
|
||||||
|
[](https://opencollective.com/git-quick-stats/sponsor/3/website)
|
||||||
### Dependencies
|
[](https://opencollective.com/git-quick-stats/sponsor/4/website)
|
||||||
|
[](https://opencollective.com/git-quick-stats/sponsor/5/website)
|
||||||
- [`bsdextrautils`](https://packages.debian.org/sid/bsdextrautils) `apt install bsdextrautils`
|
[](https://opencollective.com/git-quick-stats/sponsor/6/website)
|
||||||
- [`coreutils`](https://packages.debian.org/sid/coreutils) `apt install coreutils`
|
[](https://opencollective.com/git-quick-stats/sponsor/7/website)
|
||||||
- [`gawk`](https://packages.debian.org/sid/gawk) `apt install gawk`
|
[](https://opencollective.com/git-quick-stats/sponsor/8/website)
|
||||||
- [`grep`](https://packages.debian.org/sid/grep) `apt install grep`
|
[](https://opencollective.com/git-quick-stats/sponsor/9/website)
|
||||||
- [`ncurses-bin`](https://packages.debian.org/sid/ncurses-bin) `apt install ncurses-bin`
|
|
||||||
|
[](https://quaestor.com/?utm_source=github&utm_category=sponsor)
|
||||||
## 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 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 about [git log --submodule](https://git-scm.com/docs/git-log#Documentation/git-log.txt---submoduleltformatgt))
|
|
||||||
|
|
||||||
## Contribution
|
|
||||||
|
|
||||||
Want to contribute? Great! First, read this page.
|
|
||||||
|
|
||||||
### Code reviews
|
|
||||||
|
|
||||||
All submissions, including submissions by project members, require review.</br>
|
|
||||||
We use GitHub pull requests for this purpose.
|
|
||||||
|
|
||||||
### Some tips for good pull requests
|
|
||||||
|
|
||||||
- Use our code </br>
|
|
||||||
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](http://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message)
|
|
||||||
and [here](https://www.kernel.org/doc/Documentation/SubmittingPatches).
|
|
||||||
- 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](https://help.github.com/articles/markdown-basics/). Please submit your changes using the same syntax.
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
[](https://codecov.io/gh/arzzen/git-quick-stats)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
make test
|
|
||||||
```
|
|
||||||
|
|
||||||
## 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.
|
|
||||||
|
|
||||||
[](https://github.com/git-quick-stats/git-quick-stats/graphs/contributors)
|
|
||||||
|
|
|
||||||
1272
git-quick-stats
1272
git-quick-stats
File diff suppressed because it is too large
Load diff
|
|
@ -1,233 +1,161 @@
|
||||||
.TH git-quick-stats "1" "June 2025" "git-quick-stats" "User Commands"
|
.TH git-quick-stats "1" "June 2021" "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 PLATFORM NOTES
|
.SH GENERATE OPTIONS
|
||||||
.PP
|
.PP
|
||||||
git-quick-stats requires GNU date support for date parsing options.
|
\fB\-T\fR, \fB\-\-detailed\-git\-stats\fR
|
||||||
.PP
|
.IP
|
||||||
On macOS, install GNU coreutils with:
|
give a detailed list of git stats
|
||||||
.PP
|
.HP
|
||||||
.B brew install coreutils
|
.PP
|
||||||
.PP
|
\fB\-R\fR, \fB\-\-git\-stats\-by\-branch\fR
|
||||||
On FreeBSD, install GNU coreutils with:
|
.IP
|
||||||
.PP
|
see detailed list of git stats by branch
|
||||||
.B pkg install coreutils
|
.HP
|
||||||
.PP
|
.PP
|
||||||
GNU date may be available as either
|
\fB\-c\fR, \fB\-\-changelogs\fR
|
||||||
.B date
|
.IP
|
||||||
or
|
see changelogs
|
||||||
.B gdate
|
.HP
|
||||||
and git-quick-stats auto-detects both.
|
.PP
|
||||||
.PP
|
\fB\-L\fR, \fB\-\-changelogs\-by\-author\fR
|
||||||
.SH GENERATE OPTIONS
|
.IP
|
||||||
.PP
|
see changelogs by author
|
||||||
\fB\-h\fR, \-?, \fB\-\-help\fR
|
.HP
|
||||||
.IP
|
.PP
|
||||||
display this help text in the terminal
|
\fB\-S\fR, \fB\-\-my\-daily\-stats\fR
|
||||||
.PP
|
.IP
|
||||||
\fB\-T\fR, \fB\-\-detailed\-git\-stats\fR
|
see your current daily stats
|
||||||
.IP
|
.HP
|
||||||
give a detailed list of git stats
|
.PP
|
||||||
.HP
|
\fB\-V\fR, \fB\-\-csv\-output\-by\-branch\fR
|
||||||
.PP
|
.IP
|
||||||
\fB\-R\fR, \fB\-\-git\-stats\-by\-branch\fR
|
output daily stats by branch in CSV format
|
||||||
.IP
|
.HP
|
||||||
see detailed list of git stats by branch
|
.PP
|
||||||
.HP
|
\fB\-j\fR, \fB\-\-json\-output\fR
|
||||||
.PP
|
.IP
|
||||||
\fB\-c\fR, \fB\-\-changelogs\fR
|
save git log as a JSON formatted file to a specified area
|
||||||
.IP
|
.HP
|
||||||
see changelogs
|
.SH LIST OPTIONS
|
||||||
.HP
|
.PP
|
||||||
.PP
|
\fB\-b\fR, \fB\-\-branch\-tree\fR
|
||||||
\fB\-L\fR, \fB\-\-changelogs\-by\-author\fR
|
.IP
|
||||||
.IP
|
show an ASCII graph of the git repo branch history
|
||||||
see changelogs by author
|
.HP
|
||||||
.HP
|
.PP
|
||||||
.PP
|
\fB\-D\fR, \fB\-\-branches\-by\-date\fR
|
||||||
\fB\-S\fR, \fB\-\-my\-daily\-stats\fR
|
.IP
|
||||||
.IP
|
show branches by date
|
||||||
see your current daily stats
|
.HP
|
||||||
.HP
|
.PP
|
||||||
.PP
|
\fB\-C\fR, \fB\-\-contributors\fR
|
||||||
\fB\-V\fR, \fB\-\-csv\-output\-by\-branch\fR
|
.IP
|
||||||
.IP
|
see a list of everyone who contributed to the repo
|
||||||
output daily stats by branch in CSV format
|
.HP
|
||||||
.HP
|
.PP
|
||||||
.PP
|
\fB\-a\fR, \fB\-\-commits\-per\-author\fR
|
||||||
\fB\-j\fR, \fB\-\-json\-output\fR
|
.IP
|
||||||
.IP
|
displays a list of commits per author
|
||||||
save git log as a JSON formatted file to a specified area
|
.HP
|
||||||
.HP
|
.PP
|
||||||
.SH LIST OPTIONS
|
\fB\-d\fR, \fB\-\-commits\-per\-day\fR
|
||||||
.PP
|
.IP
|
||||||
\fB\-b\fR, \fB\-\-branch\-tree\fR
|
displays a list of commits per day
|
||||||
.IP
|
.HP
|
||||||
show an ASCII graph of the git repo branch history
|
.PP
|
||||||
.HP
|
\fB\-m\fR, \fB\-\-commits\-by\-month\fR
|
||||||
.PP
|
.IP
|
||||||
\fB\-D\fR, \fB\-\-branches\-by\-date\fR
|
displays a list of commits per month
|
||||||
.IP
|
.HP
|
||||||
show branches by date
|
.PP
|
||||||
.HP
|
\fB\-Y\fR, \fB\-\-commits\-by\-year\fR
|
||||||
.PP
|
.IP
|
||||||
\fB\-C\fR, \fB\-\-contributors\fR
|
displays a list of commits per year
|
||||||
.IP
|
.HP
|
||||||
see a list of everyone who contributed to the repo
|
.PP
|
||||||
.HP
|
\fB\-w\fR, \fB\-\-commits\-by\-weekday\fR
|
||||||
.PP
|
.IP
|
||||||
\fB\-n\fR, \fB\-\-new\-contributors\fR
|
displays a list of commits per weekday
|
||||||
.IP
|
.HP
|
||||||
list everyone who made their first contribution since a specified date
|
.PP
|
||||||
.HP
|
\fB\-o\fR, \fB\-\-commits\-by\-hour\fR
|
||||||
.PP
|
.IP
|
||||||
\fB\-N\fR, \fB\-\-new\-contributors\-since\-tag\fR
|
displays a list of commits per hour
|
||||||
.IP
|
.HP
|
||||||
list everyone who made their first contribution since a specified git tag
|
.PP
|
||||||
.HP
|
\fB\-A\fR, \fB\-\-commits\-by\-author\-by\-hour\fR
|
||||||
.PP
|
.IP
|
||||||
\fB\-a\fR, \fB\-\-commits\-per\-author\fR
|
displays a list of commits per hour by author
|
||||||
.IP
|
.HP
|
||||||
displays a list of commits per author
|
.PP
|
||||||
.HP
|
\fB\-z\fR, \fB\-\-commits\-by\-timezone\fR
|
||||||
.PP
|
.IP
|
||||||
\fB\-d\fR, \fB\-\-commits\-per\-day\fR
|
displays a list of commits per timezone
|
||||||
.IP
|
.HP
|
||||||
displays a list of commits per day
|
.PP
|
||||||
.HP
|
\fB\-Z\fR, \fB\-\-commits\-by\-author\-by\-timezone\fR
|
||||||
.PP
|
.IP
|
||||||
\fB\-m\fR, \fB\-\-commits\-by\-month\fR
|
displays a list of commits per timezone by author
|
||||||
.IP
|
.HP
|
||||||
displays a list of commits per month
|
.SH SUGGEST OPTIONS
|
||||||
.HP
|
.PP
|
||||||
.PP
|
\fB\-r\fR, \fB\-\-suggest\-reviewers\fR
|
||||||
\fB\-Y\fR, \fB\-\-commits\-by\-year\fR
|
.IP
|
||||||
.IP
|
show the best people to contact to review code
|
||||||
displays a list of commits per year
|
.HP
|
||||||
.HP
|
.PP
|
||||||
.PP
|
\fB\-h\fR, \-?, \fB\-\-help\fR
|
||||||
\fB\-w\fR, \fB\-\-commits\-by\-weekday\fR
|
.IP
|
||||||
.IP
|
display this help text in the terminal
|
||||||
displays a list of commits per weekday
|
.PP
|
||||||
.HP
|
.SH ADDITIONAL USAGE
|
||||||
.PP
|
You can set _GIT_SINCE and _GIT_UNTIL to limit the git time log, example:
|
||||||
\fB\-W\fR, \fB\-\-commits\-by\-author\-by\-weekday\fR
|
.PP
|
||||||
.IP
|
.B export _GIT_SINCE="2017\-01\-20"
|
||||||
displays a list of commits per weekday by author
|
.PP
|
||||||
.HP
|
You can set _GIT_LIMIT for limited output log, example:
|
||||||
.PP
|
.PP
|
||||||
\fB\-o\fR, \fB\-\-commits\-by\-hour\fR
|
.B export _GIT_LIMIT=20
|
||||||
.IP
|
.PP
|
||||||
displays a list of commits per hour
|
You can set _GIT_LOG_OPTIONS for git log options, example:
|
||||||
.HP
|
.PP
|
||||||
.PP
|
.B export _GIT_LOG_OPTIONS="--ignore-all-space --ignore-blank-lines"
|
||||||
\fB\-A\fR, \fB\-\-commits\-by\-author\-by\-hour\fR
|
.PP
|
||||||
.IP
|
You can exclude directories or files from the stats by using pathspec, example:
|
||||||
displays a list of commits per hour by author
|
.PP
|
||||||
.HP
|
.B export _GIT_PATHSPEC=':!pattern'
|
||||||
.PP
|
.PP
|
||||||
\fB\-z\fR, \fB\-\-commits\-by\-timezone\fR
|
You can set _GIT_MERGE_VIEW to show merge commits with normal commits, example:
|
||||||
.IP
|
.PP
|
||||||
displays a list of commits per timezone
|
.B export _GIT_MERGE_VIEW="enable"
|
||||||
.HP
|
.PP
|
||||||
.PP
|
You can also set _GIT_MERGE_VIEW to only show merge commits, example:
|
||||||
\fB\-Z\fR, \fB\-\-commits\-by\-author\-by\-timezone\fR
|
.PP
|
||||||
.IP
|
.B export _GIT_MERGE_VIEW="exclusive"
|
||||||
displays a list of commits per timezone by author
|
.PP
|
||||||
.HP
|
You can switch to the legacy color scheme, example:
|
||||||
.PP
|
.PP
|
||||||
\fB\-\-activity\-calendar\fR
|
.B export _MENU_THEME=legacy
|
||||||
.IP
|
.PP
|
||||||
displays a calendar-style grid of commit activity per day-of-week and month for a selected author.
|
You can set _GIT_BRANCH to set the branch of the stats, example:
|
||||||
.HP
|
.PP
|
||||||
.SH SUGGEST OPTIONS
|
.B export _GIT_BRANCH="master"
|
||||||
.PP
|
.
|
||||||
\fB\-r\fR, \fB\-\-suggest\-reviewers\fR
|
.fi
|
||||||
.IP
|
|
||||||
show the best people to contact to review code
|
|
||||||
.HP
|
|
||||||
.PP
|
|
||||||
.SH CALENDAR OPTIONS
|
|
||||||
.PP
|
|
||||||
\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
|
|
||||||
\fB\-H\fR, \fB\-\-commits\-heatmap\fR shows a heatmap of commits per day per hour for the last 30 days
|
|
||||||
.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_TAG to define the default tag used by the "new contributors since tag" option, example:
|
|
||||||
.PP
|
|
||||||
.B export _GIT_TAG="foo"
|
|
||||||
.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 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
|
|
||||||
|
|
|
||||||
|
|
@ -1,17 +1,9 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
# Verify we are in a git repo. Create one if not
|
|
||||||
# FIXME: All the paths are hardcoded currently and will break if anything
|
|
||||||
# in this chain moves or gets executed elsewhere. Adjust all of these so
|
|
||||||
# pathing does not matter as much such as creating a TOP variable that
|
|
||||||
# does something like TOP=$(cd "$(dirname "$0")" || exit ; pwd -P)
|
|
||||||
# or maybe leverages Make to handle these as test targets
|
|
||||||
./tests/test-git/resetgit
|
|
||||||
|
|
||||||
. tests/assert.sh -v
|
. tests/assert.sh -v
|
||||||
|
|
||||||
src="./git-quick-stats"
|
src="./git-quick-stats"
|
||||||
assert "$src fail" "Invalid argument: fail
|
assert "$src fail" "Invalid argument
|
||||||
|
|
||||||
NAME
|
NAME
|
||||||
git-quick-stats - Simple and efficient way to access various stats in a git repo
|
git-quick-stats - Simple and efficient way to access various stats in a git repo
|
||||||
|
|
@ -24,7 +16,7 @@ DESCRIPTION
|
||||||
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.
|
||||||
|
|
||||||
GENERATE OPTIONS
|
GENERATE OPTIONS
|
||||||
|
|
@ -50,10 +42,6 @@ LIST OPTIONS
|
||||||
show branches by date
|
show branches by date
|
||||||
-C, --contributors
|
-C, --contributors
|
||||||
see a list of everyone who contributed to the repo
|
see a list of everyone who contributed to the repo
|
||||||
-n, --new-contributors
|
|
||||||
list everyone who made their first contribution since a specified date
|
|
||||||
-N, --new-contributors-since-tag
|
|
||||||
list everyone who made their first contribution since a specified tag
|
|
||||||
-a, --commits-per-author
|
-a, --commits-per-author
|
||||||
displays a list of commits per author
|
displays a list of commits per author
|
||||||
-d, --commits-per-day
|
-d, --commits-per-day
|
||||||
|
|
@ -64,8 +52,6 @@ LIST OPTIONS
|
||||||
displays a list of commits per year
|
displays a list of commits per year
|
||||||
-w, --commits-by-weekday
|
-w, --commits-by-weekday
|
||||||
displays a list of commits per 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
|
-o, --commits-by-hour
|
||||||
displays a list of commits per hour
|
displays a list of commits per hour
|
||||||
-A, --commits-by-author-by-hour
|
-A, --commits-by-author-by-hour
|
||||||
|
|
@ -75,12 +61,6 @@ LIST OPTIONS
|
||||||
-Z, --commits-by-author-by-timezone
|
-Z, --commits-by-author-by-timezone
|
||||||
displays a list of commits per timezone by author
|
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
|
SUGGEST OPTIONS
|
||||||
-r, --suggest-reviewers
|
-r, --suggest-reviewers
|
||||||
show the best people to contact to review code
|
show the best people to contact to review code
|
||||||
|
|
@ -100,34 +80,22 @@ ADDITIONAL USAGE
|
||||||
ex: export _GIT_MERGE_VIEW=enable
|
ex: export _GIT_MERGE_VIEW=enable
|
||||||
You can also set _GIT_MERGE_VIEW to only show merge commits
|
You can also set _GIT_MERGE_VIEW to only show merge commits
|
||||||
ex: export _GIT_MERGE_VIEW=exclusive
|
ex: export _GIT_MERGE_VIEW=exclusive
|
||||||
You can change to the legacy color scheme by toggling the variable \"_MENU_THEME\" between \"default\" and \"legacy\".
|
You can set _MENU_THEME to display the legacy color scheme
|
||||||
You can completely disable the color theme by setting the \"_MENU_THEME\" variable to \"none\".
|
|
||||||
ex: export _MENU_THEME=legacy
|
ex: export _MENU_THEME=legacy
|
||||||
You can set _GIT_BRANCH to set the branch of the stats
|
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_raises "$src fail" 1
|
||||||
|
|
||||||
assert_contains "$src --suggest-reviewers" "Suggested code reviewers (based on git history)"
|
assert_contains "$src --suggest-reviewers" "Suggested code reviewers (based on git history)"
|
||||||
assert_success "$src --suggest-reviewers"
|
assert_success "$src --suggest-reviewers"
|
||||||
|
|
||||||
assert_contains "$src --detailed-git-stats" "Contribution stats (by author) on the current branch"
|
assert_contains "$src --detailed-git-stats" "Contribution stats"
|
||||||
assert_success "$src --detailed-git-stats"
|
assert_success "$src --detailed-git-stats"
|
||||||
|
|
||||||
assert_contains "$src --commits-per-day" "Git commits per date"
|
assert_contains "$src --commits-per-day" "Git commits per date"
|
||||||
assert_success "$src --commits-per-day"
|
assert_success "$src --commits-per-day"
|
||||||
|
|
||||||
assert_contains "$src --my-daily-stats" "My daily status"
|
|
||||||
assert_contains "$src --my-daily-stats" "most changed files today"
|
|
||||||
assert_contains "$src --my-daily-stats" "most active users today (excluding you)"
|
|
||||||
assert_success "$src --my-daily-stats"
|
|
||||||
|
|
||||||
assert_startswith "$src --commits-by-year" "Git commits by year"
|
assert_startswith "$src --commits-by-year" "Git commits by year"
|
||||||
assert_success "$src --commits-by-year"
|
assert_success "$src --commits-by-year"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,16 +0,0 @@
|
||||||
#!/bin/sh
|
|
||||||
# Initialises a new local Git repo for test purpose if one does not exist already
|
|
||||||
if ! git rev-parse --is-inside-work-tree >/dev/null 2>&1; then
|
|
||||||
{
|
|
||||||
git init
|
|
||||||
git config user.name "$(printf %s 'Test Git,\nfor test purpose')"
|
|
||||||
git config user.email "TestGit\o/@example.org"
|
|
||||||
|
|
||||||
printf 'test-git\n========\n' > README.md
|
|
||||||
git add README.md
|
|
||||||
git commit -m 'added readme (o\w/o)' -m 'in markdown, no \r\n, only \n' -m 'a very "simple" readme'
|
|
||||||
testChars="$(printf 'tab [%b] form feed [%b] line feed [%b] carriage return [%b]' '\x09' '\x0C' '\x0A' '\x0D')"
|
|
||||||
git notes add -m 'Some notes' -m 'out of ascii: été au cœur' -m "$testChars"
|
|
||||||
git log
|
|
||||||
} >/dev/null 2>&1
|
|
||||||
fi
|
|
||||||
Loading…
Reference in a new issue