Skip to content

Latest commit

 

History

History
96 lines (71 loc) · 2.59 KB

README.md

File metadata and controls

96 lines (71 loc) · 2.59 KB
Raw

git-branches

List of local Git repository branches with their descriptions.

semantic-release NPM version Build status

That's right: descriptions! This does not use anything custom, just shows the information available in any git repo > v1.7.9

$ git branch --edit-description
; opens editor, write something, save and exit
; or simply use
$ git config branch.master.description "description text"
$ git config branch.master.description
; shows description of branch master

Use the branches.sh script to show all branches with their descriptions at once, for example, I have two branches

$ git-branch-description
* master        this is master branch
one             this is simple branch for testing

This is same information as git branch, with descriptions in the second column.

Install

$ npm install git-br -g

git alias

Alias git sub-command by:

$ git config --global alias.br !git-br

then we can use it like:

$ git br
* master        this is master branch
one             this is simple branch for testing

Adding to .bash_profile

I found it convenient to add this feature as a function to my .bash_profile or .alias file

; .bash_profile
; list git branches with their descriptions
function branches() {
    branch=""
    branches=`git branch --list`
    while read -r branch; do
    clean_branch_name=${branch//\*\ /}
    description=`git config branch.$clean_branch_name.description`
    printf "%-15s %s\n" "$branch" "$description"
    done <<< "$branches"
}

Then anywhere in the shell I can use command branches

Small print

Author: Gleb Bahmutov © 2014

License: MIT - do anything with the code, but don't blame me if it does not work.

Spread the word: tweet, star on github, etc.

Support: if you find any problems with this module, email / tweet / open issue on Github