Metadata-Version: 2.4
Name: astral-dev-toolchain-cargo-codspeed
Version: 5.0.1
Summary: Cargo extension to build & run your codspeed benchmarks
Keywords: codspeed,benchmark,cargo
Home-Page: https://codspeed.io
Maintainer-email: Astral <hey@astral.sh>
License: MIT OR Apache-2.0
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Homepage, https://codspeed.io
Project-URL: Documentation, https://codspeed.io/docs/reference/codspeed-rust/cargo-codspeed
Project-URL: Source Code, https://github.com/CodSpeedHQ/codspeed-rust

> **Build provenance:** This package is built and distributed by [Astral](https://astral.sh) as part of [`astral-dev-toolchain`](https://github.com/astral-sh/astral-dev-toolchain).
> It packages [`cargo-codspeed`](https://github.com/CodSpeedHQ/codspeed-rust) from tag `v5.0.1` at commit `69f74b65cb10ddf68e381ccafdaa300c2e8969da`.

---

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

