commit-helper/README.md
2023-12-24 22:15:11 -05:00

1.2 KiB

commit-helper (ch)

A simple tool to help write commit messages and run git commands.

Demo

You may read a brief post about commit-helper on my website: mueezkhan.com/memos/commit-helper

Installation

Make sure you have Cargo installed, then run the following command in your terminal:

cargo install --git https://github.com/rzmk/commit-helper

Usage

To run the tool, simply run ch in your terminal:

ch

-a

If you want to run git add -A before committing, use the -a flag:

ch -a

-p

If you want to run git push after committing, use the -p flag:

ch -p

--dry-run or -d

If you want to do a dry run without actually adding or committing, use the -d or --dry-run flag:

ch --dry-run

--debug

If you want to see the debug output, use the --debug flag:

ch --debug

Note that the debug output will not be printed if you use the --dry-run flag.

Tech Stack