cargo-codspeed 2.8.0-alpha.2

Cargo extension to build & run your codspeed benchmarks
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

<div align="center">
<h1>cargo-codspeed</h1>

[![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

</div>

## Installation

### With `cargo`

```bash
cargo install cargo-codspeed --locked
```

### With `cargo-binstall`(recommended in CI)

[`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
```

## Usage

```
Usage: cargo codspeed <COMMAND>

Commands:
  build  Build the benchmarks
  run    Run the previously built benchmarks

Options:
  -h, --help     Print help information
  -V, --version  Print version information
```

## Development

### Troubleshooting

- Build error on MacOS: `ld: library 'git2' not found`

  ```
  brew install libgit2
  ```