cargo-codspeed
[![CI](https://github.com/CodSpeedHQ/codspeed-rust/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/CodSpeedHQ/codspeed-rust/actions/workflows/ci.yml)
[![Crates.io](https://img.shields.io/crates/v/cargo-codspeed)](https://crates.io/crates/cargo-codspeed)
[![Discord](https://img.shields.io/badge/chat%20on-discord-7289da.svg)](https://discord.com/invite/MxpaCfKSqF)
[![CodSpeed Badge](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/CodSpeedHQ/codspeed-rust)
A cargo subcommand for running CodSpeed on your project
## Installation
### With `cargo-binstall`(recommended)
[`cargo-binstall`](https://github.com/cargo-bins/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:
```bash
cargo install cargo-binstall
```
You can then install `cargo-codspeed` with:
```bash
cargo binstall cargo-codspeed
```
### With `cargo`
```bash
cargo install cargo-codspeed --locked
```
## Usage
```
Usage: cargo codspeed
Commands:
build Build the benchmarks
run Run the previously built benchmarks
Options:
-h, --help Print help information
-V, --version Print version information
```
## Advanced Usage
The `vendored-openssl` feature can be used to statically link with openssl with `cargo install cargo-codspeed --features vendored-openssl`.
## Development
### Troubleshooting
- Build error on MacOS: `ld: library 'git2' not found`
```
brew install libgit2
```