Getting started

Install

Install @commitlint/cli and a @commitlint/config-* / commitlint-config-* of your choice as devDependency and configure commitlint to use it.

npm

npm install --save-dev @commitlint/{cli,config-conventional}

yarn

yarn add --dev @commitlint/{cli,config-conventional}

npm (Windows)

npm install --save-dev @commitlint/config-conventional @commitlint/cli

pnpm

pnpm add --save-dev @commitlint/{cli,config-conventional}

Configuration

Configure commitlint to use conventional config

echo "export default { extends: ['@commitlint/config-conventional'] };" > commitlint.config.js

Refer to configuration documentation for more information.