How to Install bencher CLI

Install CLI with Script

Linux, Mac, & Unix

For Linux, Mac, and other Unix-like systems run the following in your terminal:

curl --proto '=https' --tlsv1.2 -sSfL https://bencher.dev/download/install-cli.sh | sh

There is an optional BENCHER_VERSION environment variable to specify an exact version of the Bencher CLI to use. Otherwise, it will default to using the latest CLI version. Specify an exact version if and only if using Bencher Self-Hosted. Do not specify an exact version if using Bencher Cloud as there are still occasional breaking changes.

export BENCHER_VERSION=0.4.31; curl --proto '=https' --tlsv1.2 -sSfL https://bencher.dev/download/install-cli.sh | sh

Alternatively, Bencher Self-Hosted users can use the install script from their own self-hosted instance to make sure they are always installing the correct version of the bencher CLI. This has the added benefit of not requiring a code change to your CI configuration when upgrading your Bencher Self-Hosted instance. For example, if your Bencher Self-Hosted Console is running at https://bencher.example.com, you could run the following:

curl --proto '=https' --tlsv1.2 -sSfL https://bencher.example.com/download/install-cli.sh | sh

Windows

For Windows systems run the following in a PowerShell terminal:

irm https://bencher.dev/download/install-cli.ps1 | iex

There is an optional BENCHER_VERSION environment variable to specify an exact version of the Bencher CLI to use. Otherwise, it will default to using the latest CLI version. Specify an exact version if and only if using Bencher Self-Hosted. Do not specify an exact version if using Bencher Cloud as there are still occasional breaking changes.

$env:BENCHER_VERSION="0.4.31"; irm https://bencher.dev/download/install-cli.ps1 | iex

Alternatively, Bencher Self-Hosted users can use the install script from their own self-hosted instance to make sure they are always installing the correct version of the bencher CLI. This has the added benefit of not requiring a code change to your CI configuration when upgrading your Bencher Self-Hosted instance. For example, if your Bencher Self-Hosted Console is running at https://bencher.example.com, you could run the following:

irm https://bencher.example.com/download/install-cli.ps1 | iex

🐰 If you get an error that says running scripts is disabled on this system:

• Open Powershell with Run as Administrator
• Run: Set-ExecutionPolicy -ExecutionPolicy RemoteSigned
• Enter: Y
• Rerun this script

GitHub Actions

Install the Bencher CLI using the GitHub Action. See how to use GitHub Actions for more details.

- uses: bencherdev/bencher@main

There is an optional version argument to specify an exact version of the Bencher CLI to use. Otherwise, it will default to using the latest CLI version. Specify an exact version if and only if using Bencher Self-Hosted. Do not specify an exact version if using Bencher Cloud as there are still occasional breaking changes.

- uses: bencherdev/bencher@main
  with:
      version: 0.4.31

From Source

For all other environments, you can try to install from source. This requires you to install Rust.

cargo install --git https://github.com/bencherdev/bencher --branch main --locked --force bencher_cli

Pre-Built Binaries

• Linux
  • x86_64
  • ARM64
• MacOS
  • x86_64
  • ARM64
• Windows
  • x86_64
  • ARM64

See the latest release page for a full list.

Packages

• Debian (.deb)
  • x86_64
  • ARM64

See the latest release page for a full list.

🐰 Congrats! You have installed bencher CLI! 🎉

Keep Going: Bencher Quick Start ➡