commit-check –help¶
usage: commit-check [-h] [-v] [-c CONFIG] [-m [MESSAGE]] [-b] [-n] [-e] [-d]
Check commit message, branch name, author name, email, and more.
options:
- -h, --help¶
- -h, --help
show this help message and exit
- -v, --version¶
- -v, --version
show program’s version number and exit
- -c, --config¶
- -c CONFIG, --config CONFIG
path to config file (cchk.toml or commit-check.toml). If not specified, searches for cchk.toml in current directory
- -m, --message¶
- -m [MESSAGE], –message [MESSAGE]
validate commit message. Optionally specify file path, otherwise reads from stdin if available
- -b, --branch¶
- -b, --branch
check current git branch name
- -n, --author-name¶
- -n, --author-name
check git author name
- -e, --author-email¶
- -e, --author-email
check git author email
- -d, --dry-run¶
- -d, --dry-run
perform a dry run without failing (always returns 0)