-
-CLI to gather performance data and upload performance reports to [CodSpeed](https://codspeed.io)
-
-[](https://github.com/CodSpeedHQ/runner/actions/workflows/ci.yml)
-[](https://discord.com/invite/MxpaCfKSqF)
-[](https://codspeed.io/)
-
-
-
-The `codspeed` CLI is designed to be used both in **local** in **CI environments**.
-
-The following CI providers are supported:
-
-- [GitHub Actions](https://docs.codspeed.io/integrations/ci/github-actions): Usage with [`@CodSpeedHQ/action`](https://github.com/CodSpeedHQ/action) is recommended.
-- [GitLab CI](https://docs.codspeed.io/integrations/ci/gitlab-ci)
-- [Buildkite](https://docs.codspeed.io/integrations/ci/buildkite)
-
-#### Other providers
-
-If you want to use the CLI with another provider, you can open an issue or chat with us on [Discord](https://discord.com/invite/MxpaCfKSqF) ๐
-
-You can check out the implementation of the [supported providers](https://github.com/CodSpeedHQ/runner/tree/main/src/run/run_environment) for reference.
+
+
+
+
+
+
+
+
+
The toolkit to optimize code and avoid performance regressions.
+
+# Key features
+
+- ๐ฏ **<1% variance** in measurements using CPU simulation - no more flaky benchmarks.
+- ๐ฅ **Differential flamegraphs** to pinpoint exactly what got slower, commit by commit.
+- ๐ฌ **PR comments & status checks** showing performance impact directly in your workflow.
+- ๐ก๏ธ **Merge protection** to block PRs that degrade performance beyond your threshold.
+- ๐ **Multi-language support** for Python, Rust, Node.js, Go, and C/C++.
+- ๐ **Run locally or in CI** - works on your machine and integrates with GitHub Actions, GitLab CI, and more.
+- ๐ **Plug your existing benchmarks** in less than 5 minutes - works with pytest, vitest, criterion, and more.
## Installation
```bash
-curl -fsSL https://github.com/CodSpeedHQ/runner/releases/latest/download/codspeed-runner-installer.sh | bash
-source "$HOME/.cargo/env"
+curl -fsSL https://codspeed.io/install.sh | sh
```
Refer to the [releases page](https://github.com/CodSpeedHQ/runner/releases) to see all available versions.
@@ -80,11 +86,11 @@ CODSPEED_LOG=debug codspeed run ...
### Changing the mode of the runner
-By default, the runner will run the benchmark in the `instrumentation` mode. You can specify the mode with the `--mode` flag of the `run` command:
+By default, the runner will run the benchmark in the `simulation` mode. You can specify the mode with the `--mode` flag of the `run` command:
```bash
-# Run in the `instrumentation` mode
-codspeed run --mode instrumentation
+# Run in the `simulation` mode
+codspeed run --mode simulation
# Run in the `walltime` mode
codspeed run --mode walltime