Skip to main content

Options

Options

Stable

Customize how Custy generates and applies project version updates.

Commandcusty version

Category

Versioning

Quick Command

custy version update

optionsversion

Overview

Version Update provides command-line options for selecting the versioning strategy, controlling how the next version is generated, and overriding the default project configuration.

When an option is omitted, Custy resolves its value from the project configuration before falling back to built-in defaults.


Available Options

Command Options

Available command-line options.

--strategy
Optional

Select the versioning strategy used to generate the next version.
--bump
Optional

Specify the version bump level such as auto, patch, minor, or major.
--tag
Optional

Provide an explicit stable or supported lifecycle version instead of generating one from a strategy.
--pre-release
Optional

Generate a pre-release version such as alpha, beta, or rc.
--post-release
Optional

Generate a post-release version when supported by the selected strategy.
--dev-release
Optional

Generate a development release when supported by the selected strategy.
--meta
Optional

Append build metadata or local version information.
--epoch
Optional

Specify the PEP 440 epoch component.

Global Options

Like every Custy command, Version Update also supports the global CLI options.

Examples include:

  • --dry-run
  • --debug
  • --log-level

Global options always appear before the command.

Example:

custy --dry-run version update


Option Resolution

When multiple sources provide the same value, Custy resolves them using the following priority:

  1. Command-line arguments.
  2. Project configuration (config.toml).
  3. Built-in defaults.

This allows project-wide defaults while still supporting temporary overrides for individual executions.


What's Next?

Continue to the Configuration page to learn how to configure default versioning behavior for your project.