husky

Modern native Git hooks made easy

Husky improves your commits and more 🐶 woof!

Install

npm install husky -D

Usage

Edit package.json > prepare script and run it once:

npm set-script prepare "husky install"
npm run prepare

Add a hook:

npx husky add .husky/pre-commit "npm test"

Make a commit:

$ git commit -m "Keep calm and commit"
# `npm test` will run

For more use cases (project in sub-directory, custom directory, CI support, ...), see documentation.

Documentation

https://typicode.github.io/husky

Important Upgrading from v4 to v7 requires migrating previous config, please see the docs.

Articles

• Why husky has dropped conventional JS config
• Why husky doesn't autoinstall anymore

License

MIT

Companies

Become a sponsor and have your logo here and in the docs

The full list of Sponsors can be viewed in the docs, on Open Collective and on GitHub sponsors.