sharkdp/hyperfine
1
1
Fork 0
mirror of https://github.com/sharkdp/hyperfine.git synced 2024-11-29 15:03:55 +03:00
Code Issues Projects Releases Wiki Activity

Add Usage section

Browse Source
This commit is contained in:
David Peter 2018-01-16 22:03:50 +01:00 committed by GitHub
parent b6ca2d6ac2
commit d5e02ff768
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -2,10 +2,6 @@
A command-line benchmarking tool (*inspired by [bench](https://github.com/Gabriel439/bench)*). A command-line benchmarking tool (*inspired by [bench](https://github.com/Gabriel439/bench)*).
``` bash
> hyperfine [OPTIONS] <command>...
```
**Demo**: Benchmarking [`fd`](https://github.com/sharkdp/fd) and [`find`](https://www.gnu.org/software/findutils/): **Demo**: Benchmarking [`fd`](https://github.com/sharkdp/fd) and [`find`](https://www.gnu.org/software/findutils/):
![hyperfine](https://i.imgur.com/5OqrGWe.gif) ![hyperfine](https://i.imgur.com/5OqrGWe.gif)
@ -17,6 +13,38 @@ A command-line benchmarking tool (*inspired by [bench](https://github.com/Gabrie
* Constant feedback about the benchmark progress and current estimates * Constant feedback about the benchmark progress and current estimates
* Warmup runs can be executed before the actual benchmark * Warmup runs can be executed before the actual benchmark
## Usage
### Basic benchmark
To run a benchmark, you can simply call `hyperfine <command>...` where the argument(s) can be any shell command. For example:
``` 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` option:
``` bash
> hyperfine --min-runs 5 'sleep 0.2' 'sleep 3.2'
```
### I/O-heavy programs
If the program execution time is limited by disk I/O, the benchmarking results can be heavily influence 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` option to perform a certain amount of program executions before the actual benchmark:
``` bash
> hyperfine --warmup 3 'grep -R TODO *'
```
Conversely, if you want to run the benchmark for a cold cache, you can use the `-S`/`--setup` option to run a special command before *each* benchmarking run. For example, to clear disk caches on Linux, you can run
``` bash
sync; echo 3 | sudo tee /proc/sys/vm/drop_caches
```
To use this with Hyperfine, call `sudo echo` to temporarily gain sudo permissions and then call:
``` bash
hyperfine -S 'sync; echo 3 | sudo tee /proc/sys/vm/drop_caches' 'grep -R TODO *'
```
## Installation ## Installation
Hyperfine can be installed via [cargo](https://doc.rust-lang.org/cargo/): Hyperfine can be installed via [cargo](https://doc.rust-lang.org/cargo/):