Skip to content
Create commiting rules for projects, auto bump versions and auto changelog generation (coming soon)
Python Shell
Branch: master
Clone or download

Github Actions Conventional Commits PyPI Package latest release Supported versions Codecov

Using commitizen cli


Commitizen is a tool designed for teams.

Its main purpose is to define a standard way of committing rules and communicating it (using the cli provided by commitizen).

The reasoning behind it is that it is easier to read, and enforces writing descriptive commits.

Besides that, having a convention on your commits makes it possible to parse them and use them for something else, like generating automatically the version or a changelog.

Commitizen features


Python 3.6+



Global installation

sudo pip3 install -U Commitizen

Python project

You can add it to your local project using one of these:

pip install -U commitizen
poetry add commitizen --dev



Run in your terminal

cz commit

or the shortcut

cz c


$ cz --help
usage: cz [-h] [--debug] [-n NAME] [--version]
        {ls,commit,c,example,info,schema,bump} ...

Commitizen is a cli tool to generate conventional commits.
For more information about the topic go to

optional arguments:
-h, --help            show this help message and exit
--debug               use debug mode
-n NAME, --name NAME  use the given commitizen
--version             get the version of the installed commitizen

    ls                  show available commitizens
    commit (c)          create new commit
    example             show commit example
    info                show information about the cz
    schema              show commit schema
    bump                bump semantic version based on the git log
    version             get the version of the installed commitizen or the
                        current project (default: installed commitizen)
    check               validates that a commit message matches the commitizen schema
    init                init commitizen configuration


Feel free to create a PR.

  1. Clone the repo.
  2. Add your modifications
  3. Create a virtualenv
  4. Run ./scripts/test
You can’t perform that action at this time.