mirror of
https://github.com/rzmk/commit-helper.git
synced 2025-12-19 05:29:24 +00:00
62 lines
1.2 KiB
Markdown
62 lines
1.2 KiB
Markdown
# commit-helper (ch)
|
|
|
|
A simple tool to help write commit messages and run git commands.
|
|
|
|
|
|
|
|
You may read a brief post about commit-helper on my website: [mueezkhan.com/memos/commit-helper](https://www.mueezkhan.com/memos/commit-helper)
|
|
|
|
## Installation
|
|
|
|
Make sure you have [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) installed, then run the following command in your terminal:
|
|
|
|
```bash
|
|
cargo install --git https://github.com/rzmk/commit-helper
|
|
```
|
|
|
|
## Usage
|
|
|
|
To run the tool, simply run `ch` in your terminal:
|
|
|
|
```bash
|
|
ch
|
|
```
|
|
|
|
### `-a`
|
|
|
|
If you want to run `git add -A` before committing, use the `-a` flag:
|
|
|
|
```bash
|
|
ch -a
|
|
```
|
|
|
|
### `-p`
|
|
|
|
If you want to run `git push` after committing, use the `-p` flag:
|
|
|
|
```bash
|
|
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:
|
|
|
|
```bash
|
|
ch --dry-run
|
|
```
|
|
|
|
### `--debug`
|
|
|
|
If you want to see the debug output, use the `--debug` flag:
|
|
|
|
```bash
|
|
ch --debug
|
|
```
|
|
|
|
Note that the debug output will not be printed if you use the `--dry-run` flag.
|
|
|
|
## Tech Stack
|
|
|
|
- [Rust](https://www.rust-lang.org/)
|
|
- [inquire](https://github.com/mikaelmello/inquire)
|