Getting started

Quick Commitlint checks commit messages against a focused set of commitlint-compatible rules using a native Zig executable. A small Node.js launcher selects the executable bundled for the current platform, with no additional runtime npm dependencies.

Install

With npm:

npm install quick-commitlint --save-dev

With Yarn:

yarn add quick-commitlint --dev

Lint your first message

Pipe a Conventional Commit message to the command:

echo "feat(parser): add fast validation" | quick-commitlint

A valid message exits with status 0. Rule errors exit with status 1; command, file, UTF-8, and configuration errors exit with status 2.

Quick Commitlint uses the conventional preset automatically. Add .quick-commitlint.json at the repository root to choose Angular or override individual rules:

{
  "preset": "angular",
  "rules": {
    "header-max-length": [2, "always", 80]
  }
}

Continue with Usage, review the accepted commit message format, or compare the complete preset defaults.

Platform support

The package supports macOS arm64/x64, Linux arm64/x64, and Windows x64. The launcher requires Node.js 24 or 25 and uses it only to select and spawn the matching bundled Zig executable.