Skip to content

iamdevlinph/git-summary-sh

 
 

Repository files navigation

Forked in order to allow it to work on Windows if using git bash, cygwin or equivalent

Installation

npm i -g git-summary

git-summary

If you ever experienced one of the following situations, git-summary is for you.

  • I don't remember where some of my repositories are...
  • Did I forgot to push that commit?
  • Do I have a repo in my system that is outdated?
  • Did someone pushed new commits to origin/master in one of my repos?
  • Did I commit that quick change I made before the pizza delivery guy rang my door?

git-summary is a bash script that will neatly list the current status of any git repos it founds within a directory or your entire system. See the example screenshot below:

Requirements

Linux

  • sudo apt-get install gawk

MacOS

  • brew install coreutils

Installation

Via aliasing

Clone this repo and alias the script. To do so, add the following line to ~\.bashrc:

alias git-summary='<PATH>/git-summary/git-summary'

<PATH> is the path to the cloned repo. Don't worry, if you ever forget where you cloned this repo, you will be able to easily find it with git-summary 😉

Via executable lookup

Copy git-summary in /usr/local/bin.

Usage

General usage:

git-summary [options] path

path is optional and the current directory will be used if left blank.

Options

  • -h: Print help and exit.
  • -l: Local summary lookup. Checks only local changes which is faster as there is no need to fetch the remote.
  • -d: Deep lookup. Will look for any git repos within the entire current directory tree. Can be slowish for large trees.

Branch status

Currently, git-summary does not list multiple branches per repo. However, for single repos git-branch-status does this beautifully.

Credits

A big thanks 🤘 to the amazing people that wrote the original versions of git-summary:

About

Summarizes multiple git repository status within a directory.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 94.7%
  • JavaScript 5.3%