Scroll to navigation

GITLINT,(1) User Commands GITLINT,(1)

NAME

gitlint, - Git commit message linter

SYNOPSIS

gitlint [OPTIONS] COMMAND [ARGS]...

DESCRIPTION

Git lint tool, checks your git commit messages for styling issues
Documentation: http://jorisroovers.github.io/gitlint

OPTIONS

Path of the target git repository. [default: current working directory]
Config file location [default: .gitlint]
Config flags in format <rule>.<option>=<value> (e.g.: -c T1.line-length=80). Flag can be used multiple times to set multiple config values.
Hash (SHA) of specific commit to lint.
The range of commits (refspec or comma-separated hashes) to lint. [default: HEAD]
Path to a directory or python module with extra user-defined rules
Ignore rules (comma-separated by id or name).
Contrib rules to enable (comma-separated by id or name).
Path to a file containing a commit-msg.
Ignore any stdin data. Useful for running in CI server.
Attempt smart guesses about meta info (like author name, email, branch, changed files, etc) for staged commits.
Hard fail when the target commit range is empty.
Verbosity, use multiple times for more verbose output (e.g.: -v, -vv, -vvv). [default: -vvv]
Silent mode (no output). Takes precedence over -v, -vv, -vvv.
Enable debugging output.
Show the version and exit.
Show this message and exit.

Commands:

Generates a sample gitlint config file.
Install gitlint as a git commit-msg hook.
Lints a git repository [default command]
Runs the gitlint commit-msg hook.
Uninstall gitlint commit-msg hook.
When no COMMAND is specified, gitlint defaults to 'gitlint lint'.

SEE ALSO

The full documentation for gitlint, is maintained as a Texinfo manual. If the info and gitlint, programs are properly installed at your site, the command

info gitlint,

should give you access to the complete manual.

June 2023 gitlint, version 0.19.1