https://github.com/sharkdp/hyperfine Skip to content Navigation Menu Toggle navigation Sign in * Product + GitHub Copilot Write better code with AI + Security Find and fix vulnerabilities + Actions Automate any workflow + Codespaces Instant dev environments + Issues Plan and track work + Code Review Manage code changes + Discussions Collaborate outside of code + Code Search Find more, search less Explore + All features + Documentation + GitHub Skills + Blog * Solutions By company size + Enterprises + Small and medium teams + Startups By use case + DevSecOps + DevOps + CI/CD + View all use cases By industry + Healthcare + Financial services + Manufacturing + Government + View all industries View all solutions * Resources Topics + AI + DevOps + Security + Software Development + View all Explore + Learning Pathways + White papers, Ebooks, Webinars + Customer Stories + Partners * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles Repositories + Topics + Trending + Collections * Enterprise + Enterprise platform AI-powered developer platform Available add-ons + Advanced Security Enterprise-grade security features + GitHub Copilot Enterprise-grade AI features + Premium Support Enterprise-grade 24/7 support * Pricing Search or jump to... Search code, repositories, users, issues, pull requests... Search [ ] Clear Search syntax tips Provide feedback We read every piece of feedback, and take your input very seriously. [ ] [ ] Include my email address so I can be contacted Cancel Submit feedback Saved searches Use saved searches to filter your results more quickly Name [ ] Query [ ] To see all available qualifiers, see our documentation. Cancel Create saved search Sign in Sign up Reseting focus 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 {{ message }} sharkdp / hyperfine Public * * Notifications You must be signed in to change notification settings * Fork 361 * Star 22.6k A command-line benchmarking tool License Apache-2.0, MIT licenses found Licenses found Apache-2.0 LICENSE-APACHE MIT LICENSE-MIT 22.6k stars 361 forks Branches Tags Activity Star Notifications You must be signed in to change notification settings * Code * Issues 36 * Pull requests 4 * Discussions * Actions * Security * Insights Additional navigation options * Code * Issues * Pull requests * Discussions * Actions * Security * Insights sharkdp/hyperfine master BranchesTags [ ] Go to file Code Folders and files Name Name Last commit message Last commit date Latest commit History 977 Commits .github .github doc doc scripts scripts src src tests tests .gitignore .gitignore CHANGELOG.md CHANGELOG.md CITATION.cff CITATION.cff Cargo.lock Cargo.lock Cargo.toml Cargo.toml LICENSE-APACHE LICENSE-APACHE LICENSE-MIT LICENSE-MIT README.md README.md build.rs build.rs View all files Repository files navigation * README * Apache-2.0 license * MIT license hyperfine CICD Version info Zhong Wen A command-line benchmarking tool. Demo: Benchmarking fd and find: hyperfine 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 benchmarks To run a benchmark, you can simply call hyperfine .... The argument(s) can be any shell command. For example: 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 and measure for at least 3 seconds. To change this, you can use the -r/--runs option: hyperfine --runs 5 'sleep 0.3' If you want to compare the runtimes of different programs, you can pass multiple commands: hyperfine 'hexdump file' 'xxd file' Warmup runs and preparation commands For programs that perform a lot of 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 option to perform a certain number of program executions before the actual benchmark: hyperfine --warmup 3 'grep -R TODO *' Conversely, if you want to run the benchmark for a cold cache, you can use the -p/--prepare option to run a special command before each timing run. For example, to clear harddisk caches on Linux, you can run sync; echo 3 | sudo tee /proc/sys/vm/drop_caches To use this specific command with hyperfine, call sudo -v to temporarily gain sudo permissions and then call: hyperfine --prepare 'sync; echo 3 | sudo tee /proc/sys/vm/drop_caches' 'grep -R TODO *' Parameterized benchmarks If you want to run a series of benchmarks where a single parameter is varied (say, the number of threads), you can use the -P/ --parameter-scan option and call: hyperfine --prepare 'make clean' --parameter-scan num_threads 1 12 'make -j {num_threads}' This also works with decimal numbers. The -D/--parameter-step-size option can be used to control the step size: hyperfine --parameter-scan delay 0.3 0.7 -D 0.2 'sleep {delay}' This runs sleep 0.3, sleep 0.5 and sleep 0.7. For non-numeric parameters, you can also supply a list of values with the -L/--parameter-list option: hyperfine -L compiler gcc,clang '{compiler} -O2 main.cpp' Intermediate shell By default, commands are executed using a predefined shell (/bin/sh on Unix, cmd.exe on Windows). If you want to use a different shell, you can use the -S, --shell option: hyperfine --shell zsh 'for i in {1..10000}; do echo test; done' Note that hyperfine always corrects for the shell spawning time. To do this, it performs a calibration procedure where it runs the shell with an empty command (multiple times), to measure the startup time of the shell. It will then subtract this time from the total to show the actual time used by the command in question. If you want to run a benchmark without an intermediate shell, you can use the -N or --shell=none option. This is helpful for very fast commands (< 5 ms) where the shell startup overhead correction would produce a significant amount of noise. Note that you cannot use shell syntax like * or ~ in this case. hyperfine -N 'grep TODO /home/user' 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 --shell=bash my_function Otherwise, inline them into or source them from the benchmarked program: hyperfine 'my_function() { sleep 1; }; my_function' echo 'alias my_alias="sleep 1"' > /tmp/my_alias.sh hyperfine '. /tmp/my_alias.sh; my_alias' Exporting results Hyperfine has multiple options for exporting benchmark results to CSV, JSON, Markdown and other formats (see --help text for details). Markdown You can use the --export-markdown option to create tables like the following: Command Mean [s] Min [s] Max [s] Relative find . -iregex '.*[0-9] 2.275 +- 2.243 2.397 9.79 +- \.jpg$' 0.046 0.22 find . -iname '*[0-9].jpg' 1.427 +- 1.405 1.468 6.14 +- 0.026 0.13 fd -HI '.*[0-9]\.jpg$' 0.232 +- 0.230 0.236 1.00 0.002 JSON The JSON output is useful if you want to analyze the benchmark results in more detail. The scripts/ folder includes a lot of helpful Python programs to further analyze benchmark results and create helpful visualizations, like a histogram of runtimes or a whisker plot to compare multiple benchmarks: [histogram] [whisker] Detailed benchmark flowchart The following chart explains the execution order of various timing runs when using options like --warmup, --prepare , --setup or --cleanup : [execution-] Installation Packaging status On Ubuntu Download the appropriate .deb package from the Release page and install it via dpkg: wget https://github.com/sharkdp/hyperfine/releases/download/v1.19.0/hyperfine_1.19.0_amd64.deb sudo dpkg -i hyperfine_1.19.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 Debian Linux On Debian Linux, hyperfine can be installed from the testing repositories: apt install hyperfine On Exherbo Linux On Exherbo Linux, hyperfine can be installed from the rust repositories: cave resolve -x repository/rust cave resolve -x 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 Flox On Flox, hyperfine can be installed as follows. flox install hyperfine Hyperfine's version in Flox follows that of Nix. On openSUSE On openSUSE, hyperfine can be installed from the official repositories: zypper install 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 On Windows Hyperfine can be installed via Chocolatey, Scoop, or Winget: choco install hyperfine scoop install hyperfine winget install hyperfine With conda Hyperfine can be installed via conda from the conda-forge channel: conda install -c conda-forge hyperfine With cargo (Linux, macOS, Windows) Hyperfine can be installed from source via cargo: cargo install --locked hyperfine Make sure that you use Rust 1.76 or newer. 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 to visualize changes in benchmark timings across your Git history. Bencher is a continuous benchmarking tool that supports hyperfine to track benchmarks and catch performance regressions in CI. Make sure to check out the scripts folder in this repository for a set of tools to work with hyperfine benchmark results. 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. Citing hyperfine Thank you for considering to cite hyperfine in your research work. Please see the information in the sidebar on how to properly cite hyperfine. License hyperfine is dual-licensed under the terms of the MIT License and the Apache License 2.0. See the LICENSE-APACHE and LICENSE-MIT files for details. About A command-line benchmarking tool Topics rust cli benchmark terminal command-line tool Resources Readme License Apache-2.0, MIT licenses found Licenses found Apache-2.0 LICENSE-APACHE MIT LICENSE-MIT Activity Stars 22.6k stars Watchers 93 watching Forks 361 forks Report repository Releases 25 v1.19.0 Latest Nov 11, 2024 + 24 releases Sponsor this project Sponsor Learn more about GitHub Sponsors Used by 223 * @sneukam * @KyraZzz * @NonoLeRobot5255 * @denis-sukhoverkhov * @Jpuetz55 * @cognitedata * @bazelbuild * @PlayForm + 215 Contributors 104 * * * * * * * * * * * * * * + 90 contributors Languages * Rust 94.4% * Python 5.6% Footer (c) 2024 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact * Manage cookies * Do not share my personal information You can't perform that action at this time.