commit-check –help¶

[1;34musage: [0m[1;35mcommit-check[0m [[32m-h[0m] [[32m-v[0m] [[32m-c [33mCONFIG[0m] [[32m-m[0m] [[32m-b[0m] [[32m-n[0m] [[32m-e[0m] [[32m-d[0m]: [[36m–no-force-push[0m] [[36m–format [33mFORMAT[0m] [[36m–no-banner[0m] [[36m–compact[0m] [[36m–conventional-commits [33mBOOL[0m] [[36m–subject-capitalized [33mBOOL[0m] [[36m–subject-imperative [33mBOOL[0m] [[36m–subject-max-length [33mINT[0m] [[36m–subject-min-length [33mINT[0m] [[36m–allow-commit-types [33mLIST[0m] [[36m–allow-merge-commits [33mBOOL[0m] [[36m–allow-revert-commits [33mBOOL[0m] [[36m–allow-empty-commits [33mBOOL[0m] [[36m–allow-fixup-commits [33mBOOL[0m] [[36m–allow-wip-commits [33mBOOL[0m] [[36m–require-body [33mBOOL[0m] [[36m–require-signed-off-by [33mBOOL[0m] [[36m–ignore-authors [33mLIST[0m] [[36m–ai-attribution [33mPOLICY[0m] [[36m–author-email-pattern [33mREGEX[0m] [[36m–author-name-pattern [33mREGEX[0m] [[36m–conventional-branch [33mBOOL[0m] [[36m–allow-branch-types [33mLIST[0m] [[36m–allow-branch-names [33mLIST[0m] [[36m–require-rebase-target [33mBRANCH[0m] [[36m–branch-ignore-authors [33mLIST[0m] [32m[commit_msg_file][0m

Check commit message, branch name, author name, email, and more.

[1;34mpositional arguments:[0m

[1;32mcommit_msg_file[0m path to commit message file (positional argument for: pre-commit compatibility)

[1;34moptions:[0m

[1;32m-h[0m, [1;36m–help[0m show this help message and exit [1;32m-v[0m, [1;36m–version[0m show program’s version number and exit [1;32m-c[0m, [1;36m–config[0m [1;33mCONFIG[0m path to config file (cchk.toml or commit-check.toml).

If not specified, searches for config in: cchk.toml, commit-check.toml, .github/cchk.toml, .github/commit- check.toml

[1;34mcheck types:[0m

Specify which validation checks to run

[1;32m-m[0m, [1;36m–message[0m validate commit message (file path can be provided as: positional argument for pre-commit compatibility)

[1;32m-b[0m, [1;36m–branch[0m check current git branch name [1;32m-n[0m, [1;36m–author-name[0m check git author name [1;32m-e[0m, [1;36m–author-email[0m check git author email [1;32m-d[0m, [1;36m–dry-run[0m perform a dry run without failing (always returns 0) [1;36m–no-force-push[0m check that no force push is being performed (uses pre-

push hook stdin when available, otherwise checks the current branch against its upstream)

[1;36m–format[0m [1;33mFORMAT[0m output format: ‘text’ (default) for human-readable: output, ‘json’ for machine-readable JSON (useful for AI agents and tooling)

[1;36m–no-banner[0m suppress the ASCII art banner on failure [1;36m–compact[0m show compact one-line-per-failure output (implies

–no-banner)

[1;34mcommit message options:[0m

Configuration options for –message validation

[1;36m–conventional-commits[0m [1;33mBOOL[0m: enforce conventional commits format (true/false)
[1;36m–subject-capitalized[0m [1;33mBOOL[0m: require subject to start with capital letter (true/false)
[1;36m–subject-imperative[0m [1;33mBOOL[0m: require subject to use imperative mood (true/false)
[1;36m–subject-max-length[0m [1;33mINT[0m: maximum length of commit subject
[1;36m–subject-min-length[0m [1;33mINT[0m: minimum length of commit subject
[1;36m–allow-commit-types[0m [1;33mLIST[0m: comma-separated list of allowed commit types (e.g., feat,fix,docs)
[1;36m–allow-merge-commits[0m [1;33mBOOL[0m: allow merge commits (true/false)
[1;36m–allow-revert-commits[0m [1;33mBOOL[0m: allow revert commits (true/false)
[1;36m–allow-empty-commits[0m [1;33mBOOL[0m: allow empty commit messages (true/false)
[1;36m–allow-fixup-commits[0m [1;33mBOOL[0m: allow fixup commits (true/false)
[1;36m–allow-wip-commits[0m [1;33mBOOL[0m: allow WIP commits (true/false)

[1;36m–require-body[0m [1;33mBOOL[0m require commit body (true/false) [1;36m–require-signed-off-by[0m [1;33mBOOL[0m

require ‘Signed-off-by’ trailer (true/false)

[1;36m–ignore-authors[0m [1;33mLIST[0m: comma-separated list of authors to ignore for commit checks
[1;36m–ai-attribution[0m [1;33mPOLICY[0m: AI attribution policy: ignore (default) or forbid. ‘forbid’ rejects commits with known AI tool signatures.
[1;36m–author-email-pattern[0m [1;33mREGEX[0m: regex to check author email (requires –author-email)
[1;36m–author-name-pattern[0m [1;33mREGEX[0m: regex to check author name (requires –author-name)

[1;34mbranch options:[0m

Configuration options for –branch validation

[1;36m–conventional-branch[0m [1;33mBOOL[0m: enforce conventional branch naming (true/false)
[1;36m–allow-branch-types[0m [1;33mLIST[0m: comma-separated list of allowed branch types (e.g., feature,bugfix,hotfix)
[1;36m–allow-branch-names[0m [1;33mLIST[0m: comma-separated list of additional allowed branch names
[1;36m–require-rebase-target[0m [1;33mBRANCH[0m: target branch for rebase validation
[1;36m–branch-ignore-authors[0m [1;33mLIST[0m: comma-separated list of authors to ignore for branch checks