Configuration
Configuration
Configure default versioning behavior through config.toml.
custy versionCategory
Quick Command
custy version updateOverview​
Custy allows projects to define their preferred versioning behavior inside
config.toml.
These settings become the default values used whenever the corresponding command-line options are omitted.
Version Configuration
config.toml Properties
Configuration fields controlling default version generation.
| Property | Type | Description | Default | Required |
|---|---|---|---|---|
strategy | semver | pep440 | commitizen | date | gitcount | Default versioning strategy used to generate the next version. | semver | No |
bump | auto | patch | minor | major | Default bump level when generating the next version. | auto | No |
Version File
Version metadata detection is configured separately.
The generated and recommended configuration is:
Custy detects an existing Python version module, static pyproject.toml
version, or Node.js package.json version. Projects without supported metadata
remain valid and use tag-only versioning. Set an explicit path only when the
project owns a different metadata file; explicit paths must exist.
Default Versioning Strategy
When no strategy is specified on the command line, Custy uses the configured default strategy.
Example:
If the strategy configuration is omitted, Custy can automatically detect an appropriate strategy based on the project type.
Default Bump Level
The configured bump level determines how the next version should be generated.
Available values include:
autopatchminormajor
Example:
The exact behavior depends on the selected versioning strategy.
Configuration Resolution
Custy resolves version settings using the following priority:
- Command-line arguments.
- Project configuration (
config.toml). - Automatic project detection (when applicable).
- Built-in defaults.
This layered approach provides predictable behavior while allowing individual commands to override project defaults.
What's Next?
Continue to Versioning Strategies to learn how each supported strategy generates version numbers and when each approach is most appropriate.