git-cc

A git extension to help write conventional commits

Usage

# you can invoke either of the below to
# interactively write a conventional commit
git cc
git cc feat          # start after the commit-type
git cc 'feat(scope)' # start after the scope

# or validate your conventional commit
git cc feat: added conventional commits # ok! creates a commit
git cc 'feat(cli): added a conventional commit' # ok! creates a commit
git cc feat add a typo  # starts interaction at the scope
git cc -m "invalid(stuff): should return 1"

Configuration

See ./commit_convention.yaml for an example configuration file.

Why write conventional commits through an interactive CLI?

Figuring out what to write for an informative commit can be difficult. The conventional commits standard helps figure out what to write. As a bonus, conventional commits facilitate generating changelogs and semantic version increments. An interactive command-line application helps with following the standard.

Licensing

git-cc is source-provided software, not free software:

To use software listed on this site to make money or for work, you need to buy a license. If you’re part of a team, everyone on your team who uses the software needs to buy one. You can try before you buy, to make sure the software works and integrates well with your prototypes.

For more details, see ./LICENSE.md.

You can buy a paid license at https://indiecc.com/~skalt/git-cc.

Installation

Manual installation

Go to the project releases page to download the appropriate packaging format. Please verify the shasum of the downloaded executable for you before you run it.

Using brew

brew tap skalt/git-cc
brew install git-cc

Using the installer script for Linux or Mac

First, take a second to verify that the installer script would correctly check the shasum of the downloaded package. Then, run the following commands:

repo=skalt/git-cc
branch=master
curl -sL https://raw.githubusercontent.com/$repo/$branch/scripts/install.sh > /tmp/install.sh
shasum -a 256 /tmp/install.sh | sed 's/^/# /g'
# 805354a9b0db5648af785086af5a4af036d5281ea5999bda055c888186d36cd7  /tmp/install.sh

chmod +x /tmp/install.sh
/tmp/install.sh --help | sed 's/^/# /g'
# USAGE: ./install.sh [-h|--help] [--download-only|--dry-run] [FMT]
# download a release of git-cc for your OS and instruction set architecture.
#
# ARGS:
#   -h|--help        print this message and exit
#   --download-only  download as FMT, but do not install
#   --dry-run        print rather than follow the download url for the binary
#   FMT              The download format. Valid values are
#                      - tar.gz (default)
#                      - apk
#                      - brew
#                      - deb
#                      - exe
#                      - rpm

/tmp/install.sh

From source with go

To compile from source, run make install inside the source directory. You'll need to have a go >= 1.19 toolchain and to have your $GOPATH/bin on your $PATH.

git clone git@bitbucket.org

Prior art:

• @commitlint/prompt-cli
• committizen
• commitsar