Skip to content

KunalSin9h/git-commit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

commit

Git commit simulator using Conventional Commits conventions.

demo

Installation

⚠️ ⚠️ Install gum first.

Install gum

Use a package manager:

# macOS or Linux
brew install gum

# Arch Linux (btw)
pacman -S gum

# Nix
nix-env -iA nixpkgs.gum

# Debian/Ubuntu
echo 'deb [trusted=yes] https://repo.charm.sh/apt/ /' | sudo tee /etc/apt/sources.list.d/charm.list
sudo apt update && sudo apt install gum

# Fedora
echo '[charm]
name=Charm
baseurl=https://repo.charm.sh/yum/
enabled=1
gpgcheck=0' | sudo tee /etc/yum.repos.d/charm.repo
sudo yum install gum

Or download it:

  • Packages are available in Debian and RPM formats
  • Binaries are available for Linux, macOS, and Windows

Or just install it with go:

go install github.com/charmbracelet/gum@latest

macOS x64 & Silicon, Linux x64, Windows Subsystem for Linux

curl -s https://kunalsin9h.com/commit | bash

After Installing, add the following to your .bashrc file

export COMMIT_INSTALL="$HOME/.commit"
export PATH="$COMMIT_INSTALL/bin:$PATH"

From Arch User Repository (AUR)

yay -S git-commit

Usage

$ commit -h
# or
$ commit --help

Go to your project directory, stage your changes and run commit command.

Note: commit command will also prompt to stage your changes.

$ cd my-project
$ commit

Inspiration

This project is inspired by gum

License

MIT