You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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/codspeed/tree/main/src/run/run_environment) for reference.
Need to bench another language or framework? Open [an issue](https://github.com/CodSpeedHQ/codspeed/issues) or let us know on [Discord](https://codspeed.io/discord)!
85
+
61
86
## Advanced usage
62
87
63
88
### Installing tools before running
@@ -70,27 +95,18 @@ codspeed setup
70
95
71
96
This is especially useful when configuring environments with tools such as docker.
72
97
73
-
### Logging level
74
-
75
-
Use the `CODSPEED_LOG` environment variable to set the logging level:
76
-
77
-
```bash
78
-
CODSPEED_LOG=debug codspeed run ...
79
-
```
80
-
81
98
### Changing the mode of the runner
82
99
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:
100
+
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
101
85
102
```bash
86
-
# Run in the `instrumentation` mode
87
-
codspeed run --mode instrumentation<my-benchmark-command>
103
+
# Run in the `simulation` mode
104
+
codspeed run --mode simulation<my-benchmark-command>
88
105
89
106
# Run in the `walltime` mode
90
107
codspeed run --mode walltime <my-benchmark-command>
91
108
```
92
109
93
110
> [!WARNING]
94
-
> We strongly recommend not changing this mode unless you know what you are doing.
95
111
> Using the `walltime` mode on traditional VMs/Hosted Runners will lead to inconsistent data. For the best results, we recommend using CodSpeed Hosted Macro Runners, which are fine-tuned for performance measurement consistency.
96
112
> Check out the [Walltime Instrument Documentation](https://docs.codspeed.io/instruments/walltime/) for more details.
0 commit comments