From ea552a9a358c60320d827ec4d0099f38338fe676 Mon Sep 17 00:00:00 2001 From: Arthur Pastel Date: Sat, 20 Dec 2025 23:57:33 +0100 Subject: [PATCH 1/6] --wip-- [skip ci] --wip-- [skip ci] --wip-- [skip ci] --wip-- [skip ci] --wip-- [skip ci] --wip-- [skip ci] --wip-- [skip ci] --wip-- [skip ci] --wip-- [skip ci] --- README.md | 62 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 33 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 5bd7f922..21e2f0bb 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,37 @@ -
-

CodSpeed CLI

- -CLI to gather performance data and upload performance reports to [CodSpeed](https://codspeed.io) - -[![CI](https://github.com/CodSpeedHQ/runner/actions/workflows/ci.yml/badge.svg)](https://github.com/CodSpeedHQ/runner/actions/workflows/ci.yml) -[![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/) - -
- -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. +

+ + + + CodSpeed logo + +

+ +

The toolkit to optimize your code and avoid performance regressions.

+

Get Started ยท Documentation

+ +
+ +

+ Latest Release + CI Status + License + Discord Chat + CodSpeed Badge +

+ +# 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++. +- ๐Ÿ”Œ **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 +84,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 From bdff7ec2baef5b64051cd780be146a6616e0e0bc Mon Sep 17 00:00:00 2001 From: Arthur Pastel Date: Tue, 23 Dec 2025 20:15:43 +0100 Subject: [PATCH 2/6] --wip-- [skip ci] --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 21e2f0bb..aff40a88 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,7 @@ - ๐Ÿ’ฌ **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 From 61d9b3f5b78430b3d5089a7d7bc52a1ee07fe3e1 Mon Sep 17 00:00:00 2001 From: Arthur Pastel Date: Wed, 24 Dec 2025 13:28:25 +0100 Subject: [PATCH 3/6] --wip-- [skip ci] --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index aff40a88..84dfebc6 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@

Latest Release + Downloads CI Status License Discord Chat From 487d1f30ee7181df9b8b8afd686309255d91c5c8 Mon Sep 17 00:00:00 2001 From: Arthur Pastel Date: Wed, 24 Dec 2025 13:30:54 +0100 Subject: [PATCH 4/6] --wip-- [skip ci] --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 84dfebc6..0dabc160 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@

Latest Release Downloads - CI Status + CI Status License Discord Chat CodSpeed Badge From a2391fd50ad880e852bb67abe5dfd77c12a5ff20 Mon Sep 17 00:00:00 2001 From: Arthur Pastel Date: Wed, 24 Dec 2025 13:36:12 +0100 Subject: [PATCH 5/6] --wip-- [skip ci] --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0dabc160..adc62dd2 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@

- Latest Release + Latest Release Downloads CI Status License From f3590a6f341a34b8031d79ba82b2032eed2bf19f Mon Sep 17 00:00:00 2001 From: Arthur Pastel Date: Thu, 25 Dec 2025 18:48:35 +0100 Subject: [PATCH 6/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index adc62dd2..7de696b5 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@

-

The toolkit to optimize your code and avoid performance regressions.

+

The toolkit to optimize code and avoid performance regressions.

Get Started ยท Documentation