mirror of
https://github.com/rzmk/commit-helper.git
synced 2025-12-19 05:29:24 +00:00
93 lines
1.9 KiB
Markdown
93 lines
1.9 KiB
Markdown
# commit-helper (ch)
|
|
|
|
A simple tool to help run commands related to `git commit` in one go.
|
|
|
|
|
|
|
|
## 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
|
|
```
|
|
|
|
## Reference
|
|
|
|
To run the interactive workflow, simply run `ch` in your terminal:
|
|
|
|
```bash
|
|
ch
|
|
```
|
|
|
|
### `--help` or `-h`
|
|
|
|
To get the help message, run `ch --help` or `ch -h`:
|
|
|
|
```bash
|
|
ch -h
|
|
```
|
|
|
|
### `--add` or `-a`
|
|
|
|
If you want to run `git add -A` before committing, use the `--add` or `-a` flag:
|
|
|
|
```bash
|
|
ch -a
|
|
```
|
|
|
|
### `--push` or `-p`
|
|
|
|
If you want to run `git push` after committing, use the `--push` or `-p` flag:
|
|
|
|
```bash
|
|
ch -p
|
|
```
|
|
|
|
### `--message` or `-m`
|
|
|
|
If you want to pass in a custom commit message (therefore skipping the interactive steps), use the `--message` or `-m` flag:
|
|
|
|
```bash
|
|
ch -m "feat: add new feature"
|
|
```
|
|
|
|
### `--debug` or `-d`
|
|
|
|
If you want to see the debug output, use the `--debug` or `-d` flag:
|
|
|
|
```bash
|
|
ch -d
|
|
```
|
|
|
|
> Note: The debug output will not be printed if you use the `--dry-run` flag.
|
|
|
|
### `--dry-run`
|
|
|
|
If you want to do a dry run without executing any commands, use the `--dry-run` flag:
|
|
|
|
```bash
|
|
ch --dry-run
|
|
```
|
|
|
|
## Example
|
|
|
|
If I want to run `git add -A`, then `git commit -m "feat: add new feature"`, then `git push` all in one go, I could run the following command:
|
|
|
|
```bash
|
|
ch -m "feat: add new feature" -a -p
|
|
```
|
|
|
|
Equivalently to the above command, I may instead combine the short flags:
|
|
|
|
```bash
|
|
ch -apm "feat: add new feature"
|
|
```
|
|
|
|
> Note: The order of the combined short flags does not matter, except for the `-m` flag, which must be the last flag if you want to pass in a custom commit message after a combination of flags.
|
|
|
|
## Tech Stack
|
|
|
|
- [Rust](https://www.rust-lang.org/)
|
|
- [clap](https://github.com/clap-rs/clap)
|
|
- [inquire](https://github.com/mikaelmello/inquire)
|