Documentation#

bumpversion rewrites every version string in a project from a single config file, then commits and tags the result. It is a Rust rewrite of bump-my-version and reads the same configuration files, so an existing project usually needs no changes at all.

Start here#

• Introduction — what a bump actually does, step by step.
• Installation — install the bumpversion binary.
• Quick start — your first config file and your first bump.

Go deeper#

• Configuration — config file formats, the files to rewrite, the version scheme, VCS behavior, hooks, and a full key reference.
• Commands — bump, show, show-bump, every flag, and the exit codes.
• Continuous integration — running a release from GitHub Actions.

Every terminal transcript on this site is generated by running the real binary against the example projects in docs/examples/, and the config files shown above them are those same files. They are regenerated on every docs build, so an example that stopped working cannot quietly stay on the page.