Skip to content

Latest commit

 

History

History
62 lines (44 loc) · 1.79 KB

README.md

File metadata and controls

62 lines (44 loc) · 1.79 KB
Raw

git-ink

Pull out the [branch] description from your .git/config; quickly edit and view your branches, with annotations; hashtag branches for easier management.

Screenshot of output

Support

  • OSX - Partial

    • the git ink command works but options do not (pending a getopts rewrite)
      • Use git branch --edit-description to add descriptions in the interim

  • Linux - Full

    • git ink and all its flags work.

Install

Put git-ink somewhere in your path.

Usage

git branch --edit-description     # opens $EDITOR to edit a description
git ink                           # pretty list of branches and descriptions
git ink -h                        # help
git ink -b dev -g                 # display description of "dev" branch
git ink -b dev -s "prepend me to existing description"
git ink -b dev -r "overwrite entire description with this"

A .gitbranch file will is the canonical source of meta data for this plugin if provided. The .gitbranch file uses the same format as gitconfig files. It MUST be added to .gitignore so it can exist in all branches (otherwise you would not have all the meta for all branches)

TODO

  • sync with the branch info and descriptions stored in .git/config.
  • find a good way to share the .gitbranch across repos and branches
  • rewrite in Ruby or Python for better compatibility
  • tests

Changelog

  • 2019-03-24

    • Release v1.0.3
    • check if user is in a rebase or merge and abort
    • print error message on unrecognized flag

  • 2015-10-26

    • Release v1.0.1
    • add header, _output_line function

  • 2015-10-22

    • Release v1.0.0
    • Fix arg parsing, var scoping, every function accepts branch name now
    • Updated screenshot

  • 2015-10-19

    • Change output formatting, indent branch descriptions