Skip to content

Version Manager

Formatters and linters can change their behavior between versions, and even minor bug fixes can affect the output of a tool. To ensure consistent behavior, gruft includes its own version manager to automatically use the correct version for formatting or linting code.

With gruft, you are guaranteed consistent operation across multiple projects between many developers and continuous integration environments.

Usage

The version is specified in the gruft.toml file, located at the root of your project. This file contains all the configuration settings for gruft.

toml
root = true
version = '2024.01.1'

NOTE

gruft uses CalVer for versioning, following the format YYYY.0M.MICRO.

When you run gruft, it will read the version from your configuration file and use the specified version. If no configuration is found, it will use the latest installed version on your system.

Upgrading

To upgrade the version of gruft installed on your system and automatically update the version specified in your gruft.toml file, run:

sh
# Upgrade to the latest version
gruft use latest 

# Alternatively, use this alias for `use latest`
gruft upgrade

To upgrade to a specific version, use:

sh
gruft use 2024.01.1

If you prefer not to update the version in your gruft.toml file, add the --skip-config flag:

sh
gruft use latest --skip-config