Skip to content

Installation

Fully supported

pip install gitlint

By default, gitlint is installed with pinned dependencies. To install gitlint with looser dependency requirements, only install gitlint-core:

pip install gitlint-core

Uninstalling gitlint

To fully uninstall gitlint, you need to remove both gitlint and gitlint-core:

pip uninstall gitlint gitlint-core 

Docker

There is a fully maintained and supported docker image for gitlint.

docker run --ulimit nofile=1024 -v $(pwd):/repo jorisroovers/gitlint # (1)

  1. --ulimit is required to work around a limitation in Docker. Details: see issue #129

Community Maintained Packages

These packages are not officially maintained by gitlint. For the latest and fully supported version, always use pip.

Brew

brew install gitlint

MacPorts

port install gitlint

Ubuntu

apt-get install gitlint

All available packages

Packaging status

Shell completion

# Bash: add to ~/.bashrc
eval "$(_GITLINT_COMPLETE=bash_source gitlint)"

# Zsh: add to ~/.zshrc
eval "$(_GITLINT_COMPLETE=zsh_source gitlint)"

# Fish: add to ~/.config/fish/completions/foo-bar.fish
eval (env _GITLINT_COMPLETE=fish_source gitlint)