# cargo-semver-tool

[![build-status](https://github.com/ddumont/cargo-semver-tool/actions/workflows/prerelease.yml/badge.svg)](https://github.com/ddumont/cargo-semver-tool/actions/workflows/prerelease.yml)

Update the version of your rust project!

## Getting Started
```console
$ cargo install cargo-semver-tool
```
### Usage
```console
$ cargo semver --help
A cargo command to help you version your rust project similar to npm-version

Usage: cargo-semver <COMMAND>

Commands:
  get   Return the project's current version
  bump  Bump the project's version
  help  Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version
```
### Available Subcommands

#### `cargo semver get`

##### Usage
```console
$ cargo semver get --help
Return the project's current version

Usage: cargo-semver get

Options:
  -h, --help  Print help
```

#### `cargo semver bump --help`

##### Usage
```console
Bump the project's version

Usage: cargo-semver bump [OPTIONS] [BUMP]

Arguments:
  [BUMP]
          [default: patch]

          Possible values:
          - major:      Bump the major digit of the version
              1.0.0   -> 2.0.0
              1.1.0   -> 2.0.0
              2.0.0-1 -> 2.0.0
          - minor:      Bump the minor digit of the version
              1.0.0   -> 1.1.0
              1.0.1   -> 1.1.0
              1.1.0-1 -> 1.1.0
          - patch:      Bump the patch digit of the version
              1.0.0   -> 1.0.1
              1.0.0-1 -> 1.0.0
          - premajor:   Bump the major digit of the version as a prerelease
              1.0.0   -> 2.0.0-0
              2.0.0-0 -> 2.0.0-1
          - preminor:   Bump the minor digit of the version as a prerelease
              1.0.0   -> 1.1.0-0
              1.1.0-0 -> 1.1.0-1
          - prepatch:   Bump the patch digit of the version as a prerelease
              1.0.0   -> 1.0.1-0
              1.0.1-0 -> 1.0.1-1
          - prerelease: Bump the prelease version, or behaves like prepatch
              1.1.0   -> 1.1.1-0
              1.1.1-0 -> 1.1.1-1
              1.1.0-5 -> 1.1.0-6
          - release:    Bump the version from a prerelease, or behaves like patch
              1.1.0   -> 1.1.1
              1.1.1-5 -> 1.1.1

Options:
  -d, --dry-run
          Display only, do not write the file

  -h, --help
          Print help (see a summary with '-h')
```

License: Apache-2.0