GITLINT,(1)

📦
version 0.19.1 · 6 versions
, in debian trixie, ubuntu questing

💖 GITLINT 💖

okay so bestie, welcome to the manual page for gitlint, manual section 1, user commands 💅 she's a Git commit message linter and she's literally the friend who reads your commit messages and gently tells you they're a mess 🎀

✨ NAME ✨

gitlint, — Git commit message linter 🌸

✨ SYNOPSIS ✨

gitlint [OPTIONS] COMMAND [ARGS]...

✨ DESCRIPTION ✨

Git lint tool, checks your git commit messages for styling issues 🦋

Documentation lives at http://jorisroovers.github.io/gitlint — go read it, it's giving thorough 📚

✨ OPTIONS ✨

  • --target DIRECTORY — Path of the target git repository. [default: current working directory] 📁
  • -C, --config FILE — Config file location [default: .gitlint] 🗂️
  • -c TEXT — 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. 🔁
  • --commit TEXT — Hash (SHA) of specific commit to lint. 🔍
  • --commits TEXT — The range of commits (refspec or comma-separated hashes) to lint. [default: HEAD] 🚂
  • -e, --extra-path PATH — Path to a directory or python module with extra user-defined rules 🧚
  • --ignore TEXT — Ignore rules (comma-separated by id or name). 🙈
  • --contrib TEXT — Contrib rules to enable (comma-separated by id or name). 👑
  • --msg-filename FILENAME — Path to a file containing a commit-msg. 📄
  • --ignore-stdin — Ignore any stdin data. Useful for running in CI server. 🖥️
  • --staged — Attempt smart guesses about meta info (like author name, email, branch, changed files, etc) for staged commits. 🧠
  • --fail-without-commits — Hard fail when the target commit range is empty. 💀
  • -v, --verbose — Verbosity, use multiple times for more verbose output (e.g.: -v, -vv, -vvv). [default: -vvv] 🗣️
  • -s, --silent — Silent mode (no output). Takes precedence over -v, -vv, -vvv. 🤫
  • -d, --debug — Enable debugging output. 🐛
  • --version — Show the version and exit. ⭐
  • --help — Show this message and exit. 🫶

🎀 Commands: 🎀

  • generate-config — Generates a sample gitlint config file. ✨
  • install-hook — Install gitlint as a git commit-msg hook. 🪝
  • lint — Lints a git repository [default command] 🔥
  • run-hook — Runs the gitlint commit-msg hook. 🏃
  • uninstall-hook — Uninstall gitlint commit-msg hook. 🚫
When no COMMAND is specified, gitlint defaults to 'gitlint lint'. no cap 🧢

✨ 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. 📖

and that's the whole thing bestie!! this was gitlint, version 0.19.1, dated May 2025, and yes the manual page is literally named GITLINT,(1) — iconic, periodt 💅✨💖

📦 where this page comes from