diff --git a/Cargo.toml b/Cargo.toml
index fcacf68..779c90e 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -5,6 +5,10 @@ edition = "2021"
repository = "https://github.com/CodSpeedHQ/runner"
publish = false
+[[bin]]
+name = "codspeed"
+path = "src/main.rs"
+
[dependencies]
anyhow = "1.0.75"
diff --git a/README.md b/README.md
index 28d3664..fbb65e0 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
-
codspeed-runner
+codspeed
-CLI to gather performance data from CI environments and upload performance reports to [CodSpeed](https://codspeed.io)
+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)
@@ -9,9 +9,9 @@ CLI to gather performance data from CI environments and upload performance repor
-The `codspeed-runner` CLI is designed to be used in CI environments.
+The `codspeed` CLI is designed to be used both in local in CI environments.
-The following providers are supported:
+The following CI providers are supported:
- [GitHub Actions](https://docs.codspeed.io/ci/github-actions): Usage with [`@CodSpeedHQ/action`](https://github.com/CodSpeedHQ/action) is recommended.
- [Buildkite](https://docs.codspeed.io/ci/buildkite)
@@ -40,11 +40,11 @@ Refer to the [releases page](https://github.com/CodSpeedHQ/runner/releases) to s
Example of a command to run benchmarks with [Vitest](https://docs.codspeed.io/benchmarks/nodejs/vitest):
```bash
-codspeed-runner run --token=$CODSPEED_TOKEN -- pnpm vitest bench
+codspeed run --token=$CODSPEED_TOKEN -- pnpm vitest bench
```
```
-Usage: codspeed-runner run [OPTIONS] [COMMAND]...
+Usage: codspeed run [OPTIONS] [COMMAND]...
Arguments:
[COMMAND]... The bench command to run
@@ -65,5 +65,5 @@ Options:
Use the `CODSPEED_LOG` environment variable to set the logging level:
```bash
-CODSPEED_LOG=debug codspeed-runner run ...
+CODSPEED_LOG=debug codspeed run ...
```
diff --git a/src/run/mod.rs b/src/run/mod.rs
index bf6dcd3..99e20a0 100644
--- a/src/run/mod.rs
+++ b/src/run/mod.rs
@@ -29,7 +29,7 @@ fn show_banner() {
VERSION
);
println!("{}", banner);
- debug!("codspeed-runner v{}", VERSION);
+ debug!("codspeed v{}", VERSION);
}
#[derive(Args, Debug)]
@@ -113,7 +113,7 @@ pub async fn run(args: RunArgs, api_client: &CodSpeedAPIClient) -> Result<()> {
if provider.get_provider_slug() == "local" {
if codspeed_config.auth.token.is_none() {
- bail!("You have to authenticate the CLI first. Run `codspeed-runner auth login`.");
+ bail!("You have to authenticate the CLI first. Run `codspeed auth login`.");
}
debug!("Using the token from the CodSpeed configuration file");
config.set_token(codspeed_config.auth.token.clone());