CINXE.COM

<!DOCTYPE html> <html lang="en-US" dir="ltr"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title>Husky</title> <meta name="description" content="Git hooks made easy"> <meta name="generator" content="VitePress v1.3.1"> <link rel="preload stylesheet" href="/husky/assets/style.DOCNAnRo.css" as="style"> <script type="module" src="/husky/assets/app.DiS5qmGo.js"></script> <link rel="preload" href="/husky/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin=""> <link rel="modulepreload" href="/husky/assets/chunks/framework.ZN-z4Lih.js"> <link rel="modulepreload" href="/husky/assets/chunks/theme.BqgLYJ6-.js"> <link rel="modulepreload" href="/husky/assets/chunks/sponsors.kuLOAY_7.js"> <link rel="modulepreload" href="/husky/assets/index.md.7sPbh-Gh.lean.js"> <link rel="icon" href="data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100"><text y=".9em" font-size="85">🐶</text></svg>"> <script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script> <script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script> </head> <body> <div id="app"><div class="Layout" data-v-d8b57b2d><span tabindex="-1" data-v-c8291ffa></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-c8291ffa> Skip to content </a><header class="VPNav" data-v-d8b57b2d data-v-7ad780c2><div class="VPNavBar has-sidebar top" data-v-7ad780c2 data-v-9fd4d1dd><div class="wrapper" data-v-9fd4d1dd><div class="container" data-v-9fd4d1dd><div class="title" data-v-9fd4d1dd><div class="VPNavBarTitle has-sidebar" data-v-9fd4d1dd data-v-0ad69264><a class="title" href="/husky/" data-v-0ad69264><span data-v-0ad69264>Husky</span></a></div></div><div class="content" data-v-9fd4d1dd><div class="content-body" data-v-9fd4d1dd><div class="VPNavBarSearch search" data-v-9fd4d1dd></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-9fd4d1dd data-v-afb2845e><span id="main-nav-aria-label" class="visually-hidden" data-v-afb2845e> Main Navigation </span><a class="VPLink link vp-external-link-icon VPNavBarMenuLink" href="https://github.com/sponsors/typicode" target="_blank" rel="noreferrer" tabindex="0" data-v-afb2845e data-v-08fbf4b6><span data-v-08fbf4b6>Sponsor</span></a></nav><div class="VPFlyout VPNavBarTranslations translations" data-v-9fd4d1dd data-v-acee064b data-v-af5898d3><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="Change language" data-v-af5898d3><span class="text" data-v-af5898d3><span class="vpi-languages option-icon" data-v-af5898d3></span><span class="vpi-chevron-down text-icon" data-v-af5898d3></span></span></button><div class="menu" data-v-af5898d3><div class="VPMenu" data-v-af5898d3 data-v-20ed86d6><div class="items" data-v-acee064b><p class="title" data-v-acee064b>English</p><div class="VPMenuLink" data-v-acee064b data-v-f51f088d><a class="VPLink link" href="/husky/zh/" data-v-f51f088d>简体中文</a></div><div class="VPMenuLink" data-v-acee064b data-v-f51f088d><a class="VPLink link" href="/husky/ru/" data-v-f51f088d>Русский</a></div><div class="VPMenuLink" data-v-acee064b data-v-f51f088d><a class="VPLink link" href="/husky/es/" data-v-f51f088d>Español</a></div></div></div></div></div><div class="VPNavBarAppearance appearance" data-v-9fd4d1dd data-v-3f90c1a5><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="Switch to dark theme" aria-checked="false" data-v-3f90c1a5 data-v-be9742d9 data-v-b4ccac88><span class="check" data-v-b4ccac88><span class="icon" data-v-b4ccac88><span class="vpi-sun sun" data-v-be9742d9></span><span class="vpi-moon moon" data-v-be9742d9></span></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-9fd4d1dd data-v-ef6192dc data-v-e71e869c><a class="VPSocialLink no-icon" href="https://github.com/typicode/husky" aria-label="github" target="_blank" rel="noopener" data-v-e71e869c data-v-358b6670><span class="vpi-social-github" /></a><a class="VPSocialLink no-icon" href="https://x.com/typicode" aria-label="twitter" target="_blank" rel="noopener" data-v-e71e869c data-v-358b6670><span class="vpi-social-twitter" /></a></div><div class="VPFlyout VPNavBarExtra extra" data-v-9fd4d1dd data-v-f953d92f data-v-af5898d3><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-af5898d3><span class="vpi-more-horizontal icon" data-v-af5898d3></span></button><div class="menu" data-v-af5898d3><div class="VPMenu" data-v-af5898d3 data-v-20ed86d6><div class="group translations" data-v-f953d92f><p class="trans-title" data-v-f953d92f>English</p><div class="VPMenuLink" data-v-f953d92f data-v-f51f088d><a class="VPLink link" href="/husky/zh/" data-v-f51f088d>简体中文</a></div><div class="VPMenuLink" data-v-f953d92f data-v-f51f088d><a class="VPLink link" href="/husky/ru/" data-v-f51f088d>Русский</a></div><div class="VPMenuLink" data-v-f953d92f data-v-f51f088d><a class="VPLink link" href="/husky/es/" data-v-f51f088d>Español</a></div></div><div class="group" data-v-f953d92f><div class="item appearance" data-v-f953d92f><p class="label" data-v-f953d92f>Appearance</p><div class="appearance-action" data-v-f953d92f><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="Switch to dark theme" aria-checked="false" data-v-f953d92f data-v-be9742d9 data-v-b4ccac88><span class="check" data-v-b4ccac88><span class="icon" data-v-b4ccac88><span class="vpi-sun sun" data-v-be9742d9></span><span class="vpi-moon moon" data-v-be9742d9></span></span></span></button></div></div></div><div class="group" data-v-f953d92f><div class="item social-links" data-v-f953d92f><div class="VPSocialLinks social-links-list" data-v-f953d92f data-v-e71e869c><a class="VPSocialLink no-icon" href="https://github.com/typicode/husky" aria-label="github" target="_blank" rel="noopener" data-v-e71e869c data-v-358b6670><span class="vpi-social-github" /></a><a class="VPSocialLink no-icon" href="https://x.com/typicode" aria-label="twitter" target="_blank" rel="noopener" data-v-e71e869c data-v-358b6670><span class="vpi-social-twitter" /></a></div></div></div></div></div></div><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-9fd4d1dd data-v-6bee1efd><span class="container" data-v-6bee1efd><span class="top" data-v-6bee1efd></span><span class="middle" data-v-6bee1efd></span><span class="bottom" data-v-6bee1efd></span></span></button></div></div></div></div><div class="divider" data-v-9fd4d1dd><div class="divider-line" data-v-9fd4d1dd></div></div></div></header><div class="VPLocalNav has-sidebar empty" data-v-d8b57b2d data-v-2488c25a><div class="container" data-v-2488c25a><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-2488c25a><span class="vpi-align-left menu-icon" data-v-2488c25a></span><span class="menu-text" data-v-2488c25a>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-2488c25a data-v-883964e0><button data-v-883964e0>Return to top</button></div></div></div><aside class="VPSidebar" data-v-d8b57b2d data-v-42c4c606><div class="curtain" data-v-42c4c606></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-42c4c606><span class="visually-hidden" id="sidebar-aria-label" data-v-42c4c606> Sidebar Navigation </span><div class="no-transition group" data-v-51288d80><section class="VPSidebarItem level-0 has-active" data-v-51288d80 data-v-edd2eed8><div class="items" data-v-edd2eed8><div class="VPSidebarItem level-1 is-link" data-v-edd2eed8 data-v-edd2eed8><div class="item" data-v-edd2eed8><div class="indicator" data-v-edd2eed8></div><a class="VPLink link link" href="/husky/" data-v-edd2eed8><p class="text" data-v-edd2eed8>Introduction</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-edd2eed8 data-v-edd2eed8><div class="item" data-v-edd2eed8><div class="indicator" data-v-edd2eed8></div><a class="VPLink link link" href="/husky/get-started.html" data-v-edd2eed8><p class="text" data-v-edd2eed8>Get Started</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-edd2eed8 data-v-edd2eed8><div class="item" data-v-edd2eed8><div class="indicator" data-v-edd2eed8></div><a class="VPLink link link" href="/husky/how-to.html" data-v-edd2eed8><p class="text" data-v-edd2eed8>How To</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-edd2eed8 data-v-edd2eed8><div class="item" data-v-edd2eed8><div class="indicator" data-v-edd2eed8></div><a class="VPLink link link" href="/husky/troubleshoot.html" data-v-edd2eed8><p class="text" data-v-edd2eed8>Troubleshoot</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-edd2eed8 data-v-edd2eed8><div class="item" data-v-edd2eed8><div class="indicator" data-v-edd2eed8></div><a class="VPLink link link" href="/husky/migrate-from-v4.html" data-v-edd2eed8><p class="text" data-v-edd2eed8>Migrate from v4</p></a></div></div></div></section></div></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-d8b57b2d data-v-9a6c75ad><div class="VPDoc has-sidebar has-aside" data-v-9a6c75ad data-v-e6f2a212><div class="container" data-v-e6f2a212><div class="aside" data-v-e6f2a212><div class="aside-curtain" data-v-e6f2a212></div><div class="aside-container" data-v-e6f2a212><div class="aside-content" data-v-e6f2a212><div class="VPDocAside" data-v-e6f2a212 data-v-cb998dce><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-cb998dce data-v-f610f197><div class="content" data-v-f610f197><div class="outline-marker" data-v-f610f197></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-f610f197>On this page</div><ul class="VPDocOutlineItem root" data-v-f610f197 data-v-53c99d69></ul></div></nav><div class="spacer" data-v-cb998dce></div></div></div></div></div><div class="content" data-v-e6f2a212><div class="content-container" data-v-e6f2a212><main class="main" data-v-e6f2a212><div style="position:relative;" class="vp-doc _husky_" data-v-e6f2a212><div><p><img src="https://img.shields.io/npm/dm/husky" alt="npm"></p><blockquote><p>Ultra-fast modern native git hooks</p></blockquote><p>Husky enhances your commits and more 🐶 <em>woof!</em></p><p>Automatically <strong>lint your commit messages</strong>, <strong>code</strong>, and <strong>run tests</strong> upon committing or pushing.</p><p>Get started <a href="/husky/get-started.html">here</a>.</p><h2 id="features" tabindex="-1">Features <a class="header-anchor" href="#features" aria-label="Permalink to "Features""></a></h2><ul><li>Just <code>2 kB</code> (📦 <em>gzipped</em>) with no dependencies</li><li>Fastest due to being lightweight (runs in <code>~1ms</code>)</li><li>Uses new Git feature (<code>core.hooksPath</code>)</li><li>Supports: <ul><li>macOS, Linux, Windows</li><li>Git GUIs, Node version managers, custom hooks directory, nested projects, monorepos</li><li><a href="https://git-scm.com/docs/githooks" target="_blank" rel="noreferrer">All 13 client-side Git hooks</a></li></ul></li></ul><p>And more:</p><ul><li>Branch-specific hooks</li><li>Use POSIX shell to script advanced cases</li><li>Adheres to Git's native hook organization</li><li>Aligns with <a href="https://docs.npmjs.com/cli/v10/using-npm/scripts#best-practices" target="_blank" rel="noreferrer">npm</a> best practices using <code>prepare</code> script</li><li>Opt-in/opt-out options</li><li>Can be globally disabled</li><li>User-friendly error messages</li></ul><h2 id="sponsors" tabindex="-1">Sponsors <a class="header-anchor" href="#sponsors" aria-label="Permalink to "Sponsors""></a></h2><p>Support this project by becoming a sponsor <a href="https://github.com/sponsors/typicode" target="_blank" rel="noreferrer">here</a> 💖</p><h3 id="special-sponsor" tabindex="-1">Special Sponsor <a class="header-anchor" href="#special-sponsor" aria-label="Permalink to "Special Sponsor""></a></h3><p align="center"><a href="https://app.tea.xyz/sign-up?r=8L2HWfJB6hs"><img src="https://github.com/typicode/husky/assets/5502029/1b95c571-0157-48bc-a147-0d8d2fbc1d8a"><br> Get rewards for your open-source contributions </a></p><h3 id="github" tabindex="-1">GitHub <a class="header-anchor" href="#github" aria-label="Permalink to "GitHub""></a></h3><p align="center"><a href="./sponsorkit/sponsors.svg"><img src="/husky/assets/sponsors.B1XtYgDj.svg"></a></p><h3 id="open-collective" tabindex="-1">Open Collective <a class="header-anchor" href="#open-collective" aria-label="Permalink to "Open Collective""></a></h3><p><a href="https://opencollective.com/husky/tiers/company/0/website"><img src="https://opencollective.com/husky/tiers/company/0/avatar.svg?avatarHeight=120"></a><a href="https://opencollective.com/husky/tiers/company/1/website"><img src="https://opencollective.com/husky/tiers/company/1/avatar.svg?avatarHeight=120"></a><a href="https://opencollective.com/husky/tiers/company/2/website"><img src="https://opencollective.com/husky/tiers/company/2/avatar.svg?avatarHeight=120"></a><a href="https://opencollective.com/husky/tiers/company/3/website"><img src="https://opencollective.com/husky/tiers/company/3/avatar.svg?avatarHeight=120"></a><a href="https://opencollective.com/husky/tiers/company/4/website"><img src="https://opencollective.com/husky/tiers/company/4/avatar.svg?avatarHeight=120"></a><a href="https://opencollective.com/husky/tiers/company/5/website"><img src="https://opencollective.com/husky/tiers/company/5/avatar.svg?avatarHeight=120"></a><a href="https://www.sanity.io/" target="_blank" rel="noreferrer"><img src="https://github.com/user-attachments/assets/b9c5a918-70fc-4615-ae7d-e7e5bc3c66e8" alt="image"></a></p><h2 id="used-by" tabindex="-1">Used by <a class="header-anchor" href="#used-by" aria-label="Permalink to "Used by""></a></h2><p>Husky is used in <a href="https://github.com/typicode/husky/network/dependents?package_id=UGFja2FnZS0xODQzNTgwNg%3D%3D" target="_blank" rel="noreferrer"><strong>over 1.5M projects</strong></a> on GitHub, including:</p><ul><li><a href="https://github.com/vercel/next.js" target="_blank" rel="noreferrer">vercel/next.js</a></li><li><a href="https://github.com/vercel/hyper" target="_blank" rel="noreferrer">vercel/hyper</a></li><li><a href="https://github.com/webpack/webpack" target="_blank" rel="noreferrer">webpack/webpack</a></li><li><a href="https://github.com/angular/angular" target="_blank" rel="noreferrer">angular/angular</a></li><li><a href="https://github.com/facebook/docusaurus" target="_blank" rel="noreferrer">facebook/docusaurus</a></li><li><a href="https://github.com/microsoft/vscode" target="_blank" rel="noreferrer">microsoft/vscode</a></li><li><a href="https://github.com/11ty/eleventy" target="_blank" rel="noreferrer">11ty/eleventy</a></li><li><a href="https://github.com/stylelint/stylelint" target="_blank" rel="noreferrer">stylelint/stylelint</a></li><li><a href="https://github.com/colinhacks/zod" target="_blank" rel="noreferrer">colinhacks/zod</a></li><li><a href="https://github.com/rollup/rollup" target="_blank" rel="noreferrer">rollup/rollup</a></li><li><a href="https://github.com/tinyhttp/tinyhttp" target="_blank" rel="noreferrer">tinyhttp/tinyhttp</a></li><li>...</li></ul><h2 id="articles" tabindex="-1">Articles <a class="header-anchor" href="#articles" aria-label="Permalink to "Articles""></a></h2><ul><li><a href="https://blog.typicode.com/posts/husky-git-hooks-javascript-config/" target="_blank" rel="noreferrer">Why husky has dropped conventional JS config</a></li><li><a href="https://blog.typicode.com/posts/husky-git-hooks-autoinstall/" target="_blank" rel="noreferrer">Why husky doesn't autoinstall anymore</a></li></ul></div></div></main><footer class="VPDocFooter" data-v-e6f2a212 data-v-1bcd8184><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-1bcd8184><span class="visually-hidden" id="doc-footer-aria-label" data-v-1bcd8184>Pager</span><div class="pager" data-v-1bcd8184></div><div class="pager" data-v-1bcd8184><a class="VPLink link pager-link next" href="/husky/get-started.html" data-v-1bcd8184><span class="desc" data-v-1bcd8184>Next page</span><span class="title" data-v-1bcd8184>Get Started</span></a></div></nav></footer></div></div></div></div></div></div></div> <script>window.__VP_HASH_MAP__=JSON.parse("{\"es_get-started.md\":\"Bhsd-FCq\",\"es_how-to.md\":\"BPHIPum1\",\"es_index.md\":\"CAGcCmf8\",\"es_migrate-from-v4.md\":\"BsLmHYim\",\"es_troubleshoot.md\":\"BWmBuGsk\",\"get-started.md\":\"srlYqSsp\",\"how-to.md\":\"BCw72fS8\",\"index.md\":\"7sPbh-Gh\",\"migrate-from-v4.md\":\"Cn6Ws-eM\",\"ru_get-started.md\":\"DRspITTB\",\"ru_how-to.md\":\"BiQepvkO\",\"ru_index.md\":\"D8WVkKQe\",\"ru_migrate-from-v4.md\":\"DAqp2bjg\",\"ru_troubleshoot.md\":\"2F9Ol2cg\",\"troubleshoot.md\":\"Deyr-FIp\",\"zh_get-started.md\":\"CkfaRafX\",\"zh_how-to.md\":\"Z7g2Wykr\",\"zh_index.md\":\"Dhp0tCrM\",\"zh_migrate-from-v4.md\":\"Dhj--EKy\",\"zh_troubleshoot.md\":\"BrZxJzog\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Husky\",\"description\":\"Git hooks made easy\",\"base\":\"/husky/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/typicode/husky\"},{\"icon\":\"twitter\",\"link\":\"https://x.com/typicode\"}],\"sidebar\":[{\"text\":\"Introduction\",\"link\":\"/\"},{\"text\":\"Get Started\",\"link\":\"/get-started\"},{\"text\":\"How To\",\"link\":\"/how-to\"},{\"text\":\"Troubleshoot\",\"link\":\"/troubleshoot\"},{\"text\":\"Migrate from v4\",\"link\":\"/migrate-from-v4\"}],\"nav\":[{\"text\":\"Sponsor\",\"link\":\"https://github.com/sponsors/typicode\"}]},\"locales\":{\"root\":{\"label\":\"English\",\"lang\":\"en-US\"},\"zh\":{\"label\":\"简体中文\",\"lang\":\"zh-hans\",\"description\":\"使 Git hooks 变得简单\",\"link\":\"/zh/\",\"themeConfig\":{\"sidebar\":[{\"text\":\"简介\",\"link\":\"/zh/\"},{\"text\":\"快速开始\",\"link\":\"/zh/get-started\"},{\"text\":\"如何使用\",\"link\":\"/zh/how-to\"},{\"text\":\"故障排查\",\"link\":\"/zh/troubleshoot\"},{\"text\":\"从 v4 迁移\",\"link\":\"/zh/migrate-from-v4\"}],\"docFooter\":{\"prev\":\"上一页\",\"next\":\"下一页\"},\"outline\":{\"label\":\"页面导航\"},\"nav\":[{\"text\":\"v9.0.1\",\"items\":[{\"text\":\"更新日志\",\"link\":\"https://github.com/typicode/husky/releases/tag/v9.0.1\"}]}]}},\"ru\":{\"label\":\"Русский\",\"lang\":\"ru-RU\",\"description\":\"Git hooks made easy\",\"link\":\"/ru/\",\"themeConfig\":{\"sidebar\":[{\"text\":\"Введение\",\"link\":\"/ru/\"},{\"text\":\"Начало работы\",\"link\":\"/ru/get-started\"},{\"text\":\"Как использовать\",\"link\":\"/ru/how-to\"},{\"text\":\"Устранение неполадок\",\"link\":\"/ru/troubleshoot\"},{\"text\":\"Миграция с v4\",\"link\":\"/ru/migrate-from-v4\"}],\"docFooter\":{\"prev\":\"Предыдущая страница\",\"next\":\"Следующая страница\"},\"outline\":{\"label\":\"Содержание страницы\"},\"nav\":[{\"text\":\"Sponsor\",\"link\":\"https://github.com/sponsors/typicode\"}]}},\"es\":{\"label\":\"Español\",\"lang\":\"es-EC\",\"description\":\"Git hooks se vuelven fáciles\",\"link\":\"/es/\",\"themeConfig\":{\"sidebar\":[{\"text\":\"Introducción\",\"link\":\"/es/\"},{\"text\":\"Comenzar\",\"link\":\"/es/get-started\"},{\"text\":\"Cómo hacerlo\",\"link\":\"/es/how-to\"},{\"text\":\"Solucionar problemas\",\"link\":\"/es/troubleshoot\"},{\"text\":\"Migrar desde v4\",\"link\":\"/es/migrate-from-v4\"}],\"docFooter\":{\"prev\":\"Página anterior\",\"next\":\"Página siguiente\"},\"outline\":{\"label\":\"Contenido de la página\"},\"nav\":[{\"text\":\"Sponsor\",\"link\":\"https://github.com/sponsors/typicode\"}]}}},\"scrollOffset\":134,\"cleanUrls\":false}");</script> </body> </html>