Get started

Install

npm

npm install --save-dev husky

pnpm

pnpm add --save-dev husky

yarn

yarn add --dev husky
# Add pinst ONLY if your package is not private
yarn add --dev pinst

bun

bun add --dev husky

husky init (recommended)

The init command simplifies setting up husky in a project. It creates a pre-commit script in .husky/ and updates the prepare script in package.json. Modifications can be made later to suit your workflow.

npm

npx husky init

pnpm

pnpm exec husky init

yarn

# Due to specific caveats and differences with other package managers,
# refer to the How To section.

bun

bunx husky init

Try it

Congratulations! You've successfully set up your first Git hook with just one command 🎉. Let's test it:

git commit -m "Keep calm and commit"
# test script will run every time you commit

For manual setup and more information, see the How To section.