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 -D @commitlint/cli @commitlint/config-conventional

yarn

yarn add -D @commitlint/cli @commitlint/config-conventional

pnpm

pnpm add -D @commitlint/cli @commitlint/config-conventional

bun

bun add -d @commitlint/cli @commitlint/config-conventional

deno

deno add -D npm:@commitlint/cli npm:@commitlint/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.