option.md

General Options

name

Name of the committing rules to use. What we generally call the commit conventions.

• Type: str
• Default: "cz_conventional_commits"
• Options
  • cz_conventional_commits: uses conventional commits
  • cz_jira: jira smart commits
  • cz_customize: (not recommended) customize the convention directly in the TOML file under [tool.commitizen.customize], read Customize in configuration file for more. There's a plan to provide a different functionality.

You can write your own convention, and release it on PyPI, check Customizing through a Python class.

version

Current version.

Required if you use version_provider = "commitizen".

• Type: str
• Default: None

Example: "0.1.2".

style

Style for the prompts.

• Type: list
• Default: []

It will merge this value with default style. See Styling your prompts with your favorite colors for more details.

customize

Custom rules for committing and bumping.

• Type: dict
• Default: None

Supported in TOML, JSON, and YAML configuration files.

See customization for more details.

use_shortcuts

Show keyboard shortcuts when selecting from a list. When enabled, each choice shows a shortcut key; press that key or use the arrow keys to select.

• Type: bool
• Default: False

Example

[tool.commitizen]
name = "cz_conventional_commits"
use_shortcuts = true

Run cz commit to see shortcut keys on each choice.

To customize which key is used for each choice (via the key field when using cz_customize), see shortcut keys customization.