hyperfine

中文

A command-line benchmarking tool.

Demo: Benchmarking

fd

find

Features

• Statistical analysis across multiple runs.
• Support for arbitrary shell commands.
• Constant feedback about the benchmark progress and current estimates.
• Warmup runs can be executed before the actual benchmark.
• Cache-clearing commands can be set up before each timing run.
• Statistical outlier detection to detect interference from other programs and caching effects.
• Export results to various formats: CSV, JSON, Markdown, AsciiDoc.
• Parameterized benchmarks (e.g. vary the number of threads).
• Cross-platform

Usage

Basic benchmark

To run a benchmark, you can simply call

hyperfine ...

bash
hyperfine 'sleep 0.3'

Hyperfine will automatically determine the number of runs to perform for each command. By default, it will perform at least 10 benchmarking runs. To change this, you can use the

-m

--min-runs

bash
hyperfine --min-runs 5 'sleep 0.2' 'sleep 3.2'

Warmup runs and preparation commands

If the program execution time is limited by disk I/O, the benchmarking results can be heavily influenced by disk caches and whether they are cold or warm.

If you want to run the benchmark on a warm cache, you can use the

-w

--warmup

bash
hyperfine --warmup 3 'grep -R TODO *'

Conversely, if you want to run the benchmark for a cold cache, you can use the

-p

--prepare

bash
sync; echo 3 | sudo tee /proc/sys/vm/drop_caches

sudo -v

bash
hyperfine --prepare 'sync; echo 3 | sudo tee /proc/sys/vm/drop_caches' 'grep -R TODO *'

Parameterized benchmarks

If you want to run a benchmark where only a single parameter is varied (say, the number of threads), you can use the

-P

--parameter-scan

bash
hyperfine --prepare 'make clean' --parameter-scan num_threads 1 12 'make -j {num_threads}'

-D

--parameter-step-size

bash
hyperfine --parameter-scan delay 0.3 0.7 -D 0.2 'sleep {delay}'

sleep 0.3

sleep 0.5

sleep 0.7

Shell functions and aliases

If you are using bash, you can export shell functions to directly benchmark them with hyperfine:

$ my_function() { sleep 1; }
$ export -f my_function
$ hyperfine my_function

If you are using a different shell, or if you want to benchmark shell aliases, you may try to put them in a separate file:

echo 'my_function() { sleep 1 }' > /tmp/my_function.sh
echo 'alias my_alias="sleep 1"' > /tmp/my_alias.sh
hyperfine 'source /tmp/my_function.sh; eval my_function'
hyperfine 'source /tmp/my_alias.sh; eval my_alias'

Export results

Hyperfine has multiple options for exporting benchmark results: CSV, JSON, Markdown (see

--help

--export-markdown

| Command | Mean [s] | Min [s] | Max [s] | Relative | |:---|---:|---:|---:|---:| |

find . -iregex '.*[0-9]\.jpg$'

find . -iname '*[0-9].jpg'

fd -HI '.*[0-9]\.jpg$'

The JSON output is useful if you want to analyze the benchmark results in more detail. See the

scripts/

Installation

On Ubuntu

Download the appropriate

.deb

dpkg

wget https://github.com/sharkdp/hyperfine/releases/download/v1.12.0/hyperfine_1.12.0_amd64.deb
sudo dpkg -i hyperfine_1.12.0_amd64.deb

On Fedora

On Fedora, hyperfine can be installed from the official repositories:

dnf install hyperfine

On Alpine Linux

On Alpine Linux, hyperfine can be installed from the official repositories:

apk add hyperfine

On Arch Linux

On Arch Linux, hyperfine can be installed from the official repositories:

pacman -S hyperfine

On Funtoo Linux

On Funtoo Linux, hyperfine can be installed from core-kit:

emerge app-benchmarks/hyperfine

On NixOS

On NixOS, hyperfine can be installed from the official repositories:

nix-env -i hyperfine

On Void Linux

Hyperfine can be installed via xbps

xbps-install -S hyperfine

On macOS

Hyperfine can be installed via Homebrew:

brew install hyperfine

Or you can install using MacPorts:

sudo port selfupdate
sudo port install hyperfine

On FreeBSD

Hyperfine can be installed via pkg:

pkg install hyperfine

On OpenBSD

doas pkg_add hyperfine

With conda

Hyperfine can be installed via

conda

conda-forge

conda install -c conda-forge hyperfine

With cargo (Linux, macOS, Windows)

Hyperfine can be installed via cargo:

cargo install hyperfine

Make sure that you use Rust 1.46 or higher.

From binaries (Linux, macOS, Windows)

Download the corresponding archive from the Release page.

Alternative tools

Hyperfine is inspired by bench.

Integration with other tools

Chronologer is a tool that uses

hyperfine

Make sure to check out the

scripts

hyperfine

Origin of the name

The name hyperfine was chosen in reference to the hyperfine levels of caesium 133 which play a crucial role in the definition of our base unit of time — the second.

License

hyperfine

See the LICENSE-APACHE and LICENSE-MIT files for details.