快速开始

安装

::: code-group

npm install --save-dev husky

pnpm add --save-dev husky

yarn add --dev husky
# 如果你的项目不是私有的，那么只需要安装 pinst
yarn add --dev pinst

bun add --dev husky

:::

init 命令简化了项目中的 husky 设置。它会在 .husky/ 中创建 pre-commit 脚本，并更新 package.json 中的 prepare 脚本。随后可根据你的工作流进行修改。

::: code-group

npx husky init

pnpm exec husky init

# 由于特殊的注意事项和与其他包管理器的差异，
# 请参考“如何使用”章节。

bunx husky init

:::

恭喜你！你已经成功地用一个命令设置了你的第一个 Git 钩子 🎉。让我们测试一下：

git commit -m "Keep calm and commit"
# 测试脚本会在每次提交时运行

有关手动设置和更多信息，请参见如何使用章节