diff --git a/README.md b/README.md index 5bd7f922..7de696b5 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,39 @@ -
-

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 code and avoid performance regressions.

+

Get Started ยท Documentation

+ +
+ +

+ Latest Release + Downloads + 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++. +- ๐Ÿ  **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