Installation

Commit Check runs anywhere Python does, and ships as a GitHub Action and an MCP server for the places it doesn't.

Command line

pipuvpipx

$ pip install commit-check

$ uv tool install commit-check

$ pipx install commit-check

Verify the install:

$ commit-check --version

The CLI is also available as cchk, which is the same program under a shorter name.

Supported Python versions

Commit Check supports Python 3.10 through 3.14, on Linux, macOS and Windows.

As a pre-commit hook

No installation step — pre-commit fetches it for you. See the pre-commit guide.

As a GitHub Action

No installation step. See the GitHub Actions guide.

Verifying the download

Releases are built with SLSA Level 3 provenance. To verify a release artifact came from this repository's build pipeline:

$ gh attestation verify commit_check-*.whl --repo commit-check/commit-check

Next steps

• Quick start

  ---

  Catch your first bad commit in five minutes.

  Quick start

• Rules reference

  ---

  Every rule, what it does, and why it matters.

  Rules