cargo-codspeed documentation

​

Overview

cargo-codspeed is a Cargo subcommand for running performance benchmarks with CodSpeed. It provides an easy way to build and run benchmarks for Rust projects with CodSpeed integration.

​

Installation

​

With cargo

cargo install cargo-codspeed --locked

​

With cargo-binstall (recommended in CI)

cargo-binstall enables you to install binaries directly without having to build from the source(with cargo install) every time.

If you don’t have installed yet, you can install it with:

cargo install cargo-binstall

You can then install cargo-codspeed with:

cargo binstall cargo-codspeed

​

Usage

​

Building Benchmarks

Build your benchmarks for CodSpeed:

cargo codspeed build

​

Running Benchmarks

Run the previously built benchmarks:

cargo codspeed run