darul75 / git_dash

Generates a Git metrics dashboard in terminal.

git_dash

CLI script for generating a git metrics dashboard directly in your terminal.

Examples

React Dan Abramov

Vuejs Evan You

Usage

• Open a terminal, preferably iterm2
• Navigate into your git repository folder
• Execute the following command(s)

Full history

./git_dash.sh

By author

./git_dash.sh -a githubusername

Theme

./git_dash.sh -t theme

Supported options:

./git_dash.sh -h

Usage: ./git_dash.sh [ -n NAME ] [ -t THEME ] [ -A AFTER_DATE ] [ -B BEFORE_DATE ]

Options:
-a <author>       Git author (optional)
-t <theme>        Theme (optional, default 'dark'): 'default'|'clear'|'pro'|....'
-A <after>        More recent than a specific date (YYYY-MM-DD)
-B <before>       Older than a specific date (YYYY-MM-DD)
-h                Help

Installation

Pre requisites are Git/Python installed and all python libraries should be now automatically installed at first run.

If you prefer cloning this repo, setting up an alias it is up to you.

Or simply use this

curl -sO https://raw.githubusercontent.com/darul75/git_dash/main/requirements.txt > /dev/null && bash <(curl -sL https://raw.githubusercontent.com/darul75/git_dash/main/git_dash.sh)

by author:

curl -sO https://raw.githubusercontent.com/darul75/git_dash/main/requirements.txt > /dev/null && bash <(curl -sL https://raw.githubusercontent.com/darul75/git_dash/main/git_dash.sh) -a [e-mail]

by dates:

curl -sO https://raw.githubusercontent.com/darul75/git_dash/main/requirements.txt > /dev/null && bash <(curl -sL https://raw.githubusercontent.com/darul75/git_dash/main/git_dash.sh) -a [e-mail] -A 2022-09-01 -B 2022-10-01

Options can be combined together and displayed stats dynamically adapted.

Layout

##########################################################################################
#                                       #           #           #           #            #
#                                       #   Weekly  #  Monthly  #  Yearly   # Ins vs Del #
#         Graph commit history          #           #           #           #   (since)  #
#                                       #           #           #           #  beginning #
#                                       ##################################################
#                                       #                       #                        #
#                                       #                       #                        #
#                                       #       General info    #      Top Authors       #
#                                       #                       #                        #
#                                       #                       #                        #
#                                       ##################################################
#                                       #                                                #
#                                       #                                                #
#                                       #                  Commit logs                   #
#                                       #                                                #
#                                       #                                                #
#                                       #                   (max 100)                    #
#                                       #                                                #
#                                       #                                                #
#                                       #                                                #
#                                       #                                                #
#                                       #                                                #
##########################################################################################
#                                       #                                                #
#                                       #                                                #
#        Graph Ins vs Del               #                  Top files edited              #
#                                       #                                                #
#                                       #                     (max 100)                  #
##########################################################################################

Credits

Shout to the author of Plotext who helped me a lot adding new features, fixing small issues in a record time.

Dan Abramov and Evan You as I used their respective github repository actvity in React and VueJS repositories as examples. Contact me if you want to get removed.

Coming

• after and before date options
• display loader for large repository history