Configuration

Advanced

Configure commit templates, message backups, version files, staging, and validation defaults.

Commandcusty commit

Quick Command

custy commit [OPTIONS]

configurationTOMLteam defaults

Overview

The direct command resolves values from .config/custy/config.toml when a CLI override is absent.

Configuration Groups

Commit Profile Configuration

Property	Type	Description	Default	Required
`[tool.custy.cli.templates.file]`	commit_message	Select the commit-message template used by the profile.	-	No
`[tool.custy.cli.templates.directory]`	backups_commit	Select the directory used for retained commit-message backups.	-	No
`[tool.custy.cli.paths]`	version_file	Select the project file that receives the resolved version.	-	No
`[tool.custy.cli.versioning]`	strategy	Set the default strategy used while preparing versioned artifacts.	-	No
`[tool.custy.cli.execution]`	staging and validation	Configure auto_stage, stage_mode, force_commit, and the backward-compatible check_cz override.	-	No
`[tool.custy.commit.validation]`	provider and strictness	Select auto, custy, commitizen, or git validation and decide whether an unavailable optional tool is fatal.	-	No

Example Configuration

.config/custy/config.toml

toml

[tool.custy.cli.templates.file]
commit_message = ".config/custy/templates/commit-message.txt"

[tool.custy.cli.templates.directory]
backups_commit = ".config/custy/templates/backups/commit"

[tool.custy.cli.execution]
auto_stage = false
stage_mode = "all"
force_commit = false
check_cz = false

[tool.custy.commit.validation]
provider = "auto"
require_tool = false

See the complete behavior matrix for projects with and without Commitizen configuration or installation.

Overview​

Overview