husky Documentation

Git hooks made easy ๐Ÿถ woof!

35,355 stars JavaScript JavaScript 22 files ยท ~15,590 tokens #commit#git#hooks#pre-commit
RAW Doc

File: docs/index.md

Ultra-fast modern native git hooks

Husky enhances your commits and more ๐Ÿถ woof!

Automatically lint your commit messages, code, and run tests upon committing or pushing.

Get started here.

Features

  • Just 2 kB (๐Ÿ“ฆ gzipped) with no dependencies
  • Fastest due to being lightweight (runs in ~1ms)
  • Uses new Git feature (core.hooksPath)
  • Supports:

And more:

  • Branch-specific hooks
  • Use POSIX shell to script advanced cases
  • Adheres to Git's native hook organization
  • Aligns with npm best practices using prepare script
  • Opt-in/opt-out options
  • Can be globally disabled
  • User-friendly error messages

Sponsors

Support this project by becoming a sponsor here ๐Ÿ’–

GitHub

Open Collective







Used by

Husky is used in over 1.5M projects on GitHub, including:

Articles