.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH GITLINT, "1" "June 2023" "gitlint, version 0.19.1" "User Commands"
.SH NAME
gitlint, \- Git commit message linter
.SH SYNOPSIS
.B gitlint
[\fI\,OPTIONS\/\fR] \fI\,COMMAND \/\fR[\fI\,ARGS\/\fR]...
.SH DESCRIPTION
.IP
Git lint tool, checks your git commit messages for styling issues
.IP
Documentation: http://jorisroovers.github.io/gitlint
.SH OPTIONS
.TP
\fB\-\-target\fR DIRECTORY
Path of the target git repository. [default:
current working directory]
.TP
\fB\-C\fR, \fB\-\-config\fR FILE
Config file location [default: .gitlint]
.TP
\fB\-c\fR TEXT
Config flags in format <rule>.<option>=<value>
(e.g.: \fB\-c\fR T1.line\-length=80). Flag can be used
multiple times to set multiple config values.
.TP
\fB\-\-commit\fR TEXT
Hash (SHA) of specific commit to lint.
.TP
\fB\-\-commits\fR TEXT
The range of commits (refspec or comma\-separated
hashes) to lint. [default: HEAD]
.TP
\fB\-e\fR, \fB\-\-extra\-path\fR PATH
Path to a directory or python module with extra
user\-defined rules
.TP
\fB\-\-ignore\fR TEXT
Ignore rules (comma\-separated by id or name).
.TP
\fB\-\-contrib\fR TEXT
Contrib rules to enable (comma\-separated by id or
name).
.TP
\fB\-\-msg\-filename\fR FILENAME
Path to a file containing a commit\-msg.
.TP
\fB\-\-ignore\-stdin\fR
Ignore any stdin data. Useful for running in CI
server.
.TP
\fB\-\-staged\fR
Attempt smart guesses about meta info (like author
name, email, branch, changed files, etc) for staged
commits.
.TP
\fB\-\-fail\-without\-commits\fR
Hard fail when the target commit range is empty.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Verbosity, use multiple times for more verbose
output (e.g.: \fB\-v\fR, \fB\-vv\fR, \fB\-vvv\fR). [default: \fB\-vvv]\fR
.TP
\fB\-s\fR, \fB\-\-silent\fR
Silent mode (no output). Takes precedence over \fB\-v\fR,
\fB\-vv\fR, \fB\-vvv\fR.
.TP
\fB\-d\fR, \fB\-\-debug\fR
Enable debugging output.
.TP
\fB\-\-version\fR
Show the version and exit.
.TP
\fB\-\-help\fR
Show this message and exit.
.SS "Commands:"
.TP
generate\-config
Generates a sample gitlint config file.
.TP
install\-hook
Install gitlint as a git commit\-msg hook.
.TP
lint
Lints a git repository [default command]
.TP
run\-hook
Runs the gitlint commit\-msg hook.
.TP
uninstall\-hook
Uninstall gitlint commit\-msg hook.
.IP
When no COMMAND is specified, gitlint defaults to 'gitlint lint'.
.SH "SEE ALSO"
The full documentation for
.B gitlint,
is maintained as a Texinfo manual.  If the
.B info
and
.B gitlint,
programs are properly installed at your site, the command
.IP
.B info gitlint,
.PP
should give you access to the complete manual.