|
1 | | -<div align="center"> |
2 | | -<h1>CodSpeed CLI</h1> |
3 | | - |
4 | | -CLI to gather performance data and upload performance reports to [CodSpeed](https://codspeed.io) |
5 | | - |
6 | | -[](https://github.com/CodSpeedHQ/runner/actions/workflows/ci.yml) |
7 | | -[](https://discord.com/invite/MxpaCfKSqF) |
8 | | -[](https://codspeed.io/) |
9 | | - |
10 | | -</div> |
11 | | - |
12 | | -The `codspeed` CLI is designed to be used both in **local** in **CI environments**. |
13 | | - |
14 | | -The following CI providers are supported: |
15 | | - |
16 | | -- [GitHub Actions](https://docs.codspeed.io/integrations/ci/github-actions): Usage with [`@CodSpeedHQ/action`](https://github.com/CodSpeedHQ/action) is recommended. |
17 | | -- [GitLab CI](https://docs.codspeed.io/integrations/ci/gitlab-ci) |
18 | | -- [Buildkite](https://docs.codspeed.io/integrations/ci/buildkite) |
19 | | - |
20 | | -#### Other providers |
21 | | - |
22 | | -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) 🚀 |
23 | | - |
24 | | -You can check out the implementation of the [supported providers](https://github.com/CodSpeedHQ/runner/tree/main/src/run/run_environment) for reference. |
| 1 | +<p align="center"> |
| 2 | + <picture> |
| 3 | + <source media="(prefers-color-scheme: dark)" srcset="https://codspeed.io/codspeed-logo-dark.svg"> |
| 4 | + <source media="(prefers-color-scheme: light)" srcset="https://codspeed.io/codspeed-logo-light.svg"> |
| 5 | + <img alt="CodSpeed logo" src="https://codspeed.io/codspeed-logo-light.svg" width="400px"> |
| 6 | + </picture> |
| 7 | +</p> |
| 8 | + |
| 9 | +<h3 align="center">The toolkit to optimize your code and avoid performance regressions.</h3> |
| 10 | +<p align="center"><a href="https://codspeed.io/login?flow=get-started&utm_source=github-readme">Get Started</a> · <a href="https://codspeed.io/docs?utm_source=github-readme">Documentation</a></p> |
| 11 | + |
| 12 | +<br/> |
| 13 | + |
| 14 | +<p align="center"> |
| 15 | + <a href="https://github.com/CodSpeedHQ/runner/releases/latest"><img src="https://img.shields.io/github/v/release/CodSpeedHQ/runner?label=version" alt="Latest Release"></a> |
| 16 | + <a href="https://github.com/CodSpeedHQ/runner/actions/workflows/ci.yml"><img src="https://github.com/CodSpeedHQ/runner/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI Status"></a> |
| 17 | + <a href="https://github.com/CodSpeedHQ/runner/blob/main/LICENSE-APACHE"><img src="https://img.shields.io/github/license/CodSpeedHQ/runner" alt="License"></a> |
| 18 | + <a href="https://discord.com/invite/MxpaCfKSqF"><img src="https://img.shields.io/badge/chat%20on-discord-7289da.svg" alt="Discord Chat"></a> |
| 19 | + <a href="https://codspeed.io/?utm_source=badge"><img src="https://img.shields.io/endpoint?url=https://codspeed.io/badge.json" alt="CodSpeed Badge"></a> |
| 20 | +</p> |
| 21 | + |
| 22 | +# Key features |
| 23 | + |
| 24 | +- 🎯 **<1% variance** in measurements using CPU simulation - no more flaky benchmarks. |
| 25 | +- 🔥 **Differential flamegraphs** to pinpoint exactly what got slower, commit by commit. |
| 26 | +- 💬 **PR comments & status checks** showing performance impact directly in your workflow. |
| 27 | +- 🛡️ **Merge protection** to block PRs that degrade performance beyond your threshold. |
| 28 | +- 🐍 **Multi-language support** for Python, Rust, Node.js, Go, and C/C++. |
| 29 | +- 🔌 **Plug your existing benchmarks** in less than 5 minutes - works with pytest, vitest, criterion, and more. |
25 | 30 |
|
26 | 31 | ## Installation |
27 | 32 |
|
28 | 33 | ```bash |
29 | | -curl -fsSL https://github.com/CodSpeedHQ/runner/releases/latest/download/codspeed-runner-installer.sh | bash |
30 | | -source "$HOME/.cargo/env" |
| 34 | +curl -fsSL https://codspeed.io/install.sh | sh |
31 | 35 | ``` |
32 | 36 |
|
33 | 37 | 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 ... |
80 | 84 |
|
81 | 85 | ### Changing the mode of the runner |
82 | 86 |
|
83 | | -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: |
| 87 | +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: |
84 | 88 |
|
85 | 89 | ```bash |
86 | | -# Run in the `instrumentation` mode |
87 | | -codspeed run --mode instrumentation <my-benchmark-command> |
| 90 | +# Run in the `simulation` mode |
| 91 | +codspeed run --mode simulation <my-benchmark-command> |
88 | 92 |
|
89 | 93 | # Run in the `walltime` mode |
90 | 94 | codspeed run --mode walltime <my-benchmark-command> |
|
0 commit comments