index.md

hide	navigation toc
template	home.html
title	Commit Check

Commit Check

Everything you need for commit-check

• :material-chart-line: Free & Powerful

  ---

  A fully open-source solution for validating commits, branches, and more — simple, reliable, and community-driven.

• :material-cog: Zero Configuration

  ---

  Works right out of the box with smart defaults. Power users can easily customize rules to fit their team’s workflow.

• :material-devices: Works Everywhere

  ---

  GitHub Actions, pre-commit hooks, command line, or MCP server — integrate Commit Check anywhere your code lives.

Trusted by developers worldwide

Used by developers and organizations worldwide in their production workflows.

Apache

Discovery Unicamp

Texas Instruments

OpenCADC

Extrawest

Chainlift

Mila

RLinf

Istio Ecosystem

Juniper Networks

French National Parks

OpenDriveLab

UT Austin RobIn

WorldArena2

moniqo

elu mobility

Open Energy Platform

Quick Start

=== "GitHub Actions"

Add Commit Check Action to your workflow in seconds:

```yaml
steps:
  - uses: actions/checkout@v5
    with:
      ref: ${{ github.event.pull_request.head.sha }}  # Checkout PR HEAD commit
      fetch-depth: 0  # Required for merge-base checks
  - uses: commit-check/commit-check-action@v2
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed for PR comments
    with:
      message: true
      branch: true
      author-name: true
      author-email: true
      job-summary: true
      pr-comments: ${{ github.event_name == 'pull_request' }}
```

=== "Pre-commit"

Add Commit Check to your `.pre-commit-config.yaml`:

```yaml
repos:
  repo: https://github.com/commit-check/commit-check
  rev: <tag or revision>
  hooks:
  -   id: check-message
  -   id: check-branch
  -   id: check-author-name
  -   id: check-author-email
```

=== "Command Line"

Install and run locally:

```bash
pip install commit-check

# Validate message from STDIN
echo "feat: new feature" | commit-check -m

# Validate message from file
commit-check -m commit_message.txt

# Validate the latest git commit message
commit-check -m

# And more...
```

=== "MCP Server"

Add to your AI coding agent's MCP config:

```json
{
  "mcpServers": {
    "commit-check": {
      "command": "uvx",
      "args": ["commit-check-mcp"]
    }
  }
}
```

Then your agent can validate commit messages, branch names, author info, and more with structured results.

[Learn more about MCP →](https://github.com/commit-check/commit-check-mcp)

---

Join Our Community

Be part of a growing ecosystem of developers who care about Commit Check.

GitHub Issue :fontawesome-brands-github:{ .md-button } GitHub Pull Request :fontawesome-brands-github:{ .md-button }