A Conventional commit cli built with Rust.

convco gives tools to work with Conventional Commits.

It provides the following commands:

• convco changelog: Create a changelog file.
• convco check: Checks if a range of commits is following the convention.
• convco commit: Helps to make conventional commits.
• convco version: Finds out the current or next version.
• convco config: Prints the effective configuration or the default configuration.
• convco completions: Generates tab completions for shells when convco is built with the completions feature.

Installation

Convco is built as a single binary. It does not need an additional runtime. Release archives are available from the latest GitHub release.

Linux

Download the archive for your target and put convco somewhere in your PATH.

target=x86_64-unknown-linux-musl
curl -OL "https://github.com/convco/convco/releases/latest/download/convco-${target}.tar.gz"
tar -xzf "convco-${target}.tar.gz" --strip-components=1 "convco-${target}/convco"
sudo install -m 755 convco /usr/local/bin/convco

Homebrew

For macOS or Linux:

brew install convco

Windows

Download the latest Windows archive from the GitHub releases. Extract convco.exe into a folder in your PATH.

Docker

Mount the current work directory in a volume and run convco in it.

docker run --rm -v "$PWD:/tmp" -w /tmp convco/convco --help

The image is also available from the GitHub Container Registry:

docker run --rm -v "$PWD:/tmp" -w /tmp ghcr.io/convco/convco --help

From source

cargo install convco

GitHub Actions

Use convco check in pull requests to validate the commits in the PR range.

name: Pull request
on: [pull_request]

jobs:
  convco:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 10
      - name: Validate commit messages
        shell: bash
        run: |
          set -euo pipefail
          target="x86_64-unknown-linux-musl"
          curl -sSfL "https://github.com/convco/convco/releases/latest/download/convco-${target}.tar.gz" \
            | tar -xz --strip-components=1 "convco-${target}/convco"
          chmod +x convco
          ./convco check ${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }}