krish-r / commit.sh

Conventional Commits from the terminal

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

commit.sh

Conventional Commits from the terminal.

demo

Motivation

  • I've been using VS Code Conventional Commits for sometime and I wanted to have that experience on my terminal as well.

  • I wanted to get comfortable with shell scripting 😄.

    Note:

    • This is not a 1:1 port of and this does not have all the functionalities found in VS Code Conventional Commits. I've added the functionalities which I use in my workflow.

Dependencies

git for working with git 😄
fzf for fuzzy-finding options

Install instructions

  • Copy commit.sh file somewhere in your $PATH, and make it executable. (I keep the script in ~/.local/bin)

    for example:

    wget https://raw.githubusercontent.com/krish-r/commit.sh/main/commit.sh -O ~/.local/bin/commit.sh
    
    # adds executable permission to user
    chmod u+x ~/.local/bin/commit.sh

Uninstall instructions

  • Simply remove the script from your path.

    for example:

    rm -i $(which commit.sh)

Usage

commit.sh

Credits

About

Conventional Commits from the terminal

License:MIT License


Languages

Language:Shell 100.0%