phoronix-test-suite(1)

📦
version 10.8.6~20260826gitf977d6e · 2 versions
, in epel 10, epel 9, fedora 43, fedora 44

💖 NAME 💖

hey bestie, welcome to the phoronix-test-suite(1) manual page! phoronix-test-suite is The Phoronix Test Suite — an extensible open-source platform for performing testing and performance evaluation. ✨

💫 SYNOPSIS 💫

phoronix-test-suite [options]
phoronix-test-suite benchmark [test | suite]

🌸 DESCRIPTION 🌸

okay so The Phoronix Test Suite is literally the most comprehensive testing and benchmarking platform available for Linux, Solaris, macOS, Windows, and BSD operating systems. 🦋 It lets you carry out tests in a fully automated manner from test installation to execution and reporting. Every test is meant to be easily reproducible, easy-to-use, and supports fully automated execution. No cap. The Phoronix Test Suite is open-source under the GNU GPLv3 license and is developed by Phoronix Media in cooperation with partners. 💅

👑 OPTIONS 👑

🌈 SYSTEM 🌈

  • interactive — A simple text-driven interactive interface to the Phoronix Test Suite. 💖

💻 php-conf 💻

This option will print information that is useful to developers when debugging problems with the Phoronix Test Suite and/or test profiles and test suites. 🛠️

🐚 shell 🐚

A simple text-driven shell interface / helper to the Phoronix Test Suite. Ideal for those that may be new to the Phoronix Test Suite. 🌱

🖥️ system-info 🖥️

Display the installed system hardware and software information as detected by the Phoronix Test Suite Phodevi Library. ✨

🧬 system-properties 🧬

Display various hardware/software system properties detected by the Phoronix Device Interface (Phodevi) library. 🔍

🌡️ system-sensors 🌡️

Display the installed system hardware and software sensors in real-time as detected by the Phoronix Test Suite Phodevi Library. 🔥

🛠️ TEST INSTALLATION 🛠️

  • force-install [Test | Suite | OpenBenchmarking ID | Test Result] ... — This option will force the installation (or re-installation) of a test or suite. The arguments and process is similar to the install option but even if the test is installed, the entire installation process will automatically be executed. This option is generally used when debugging a test installation problem or wishing to re-install test(s) due to compiler or other environmental changes. 💥
  • install [Test | Suite | OpenBenchmarking ID | Test Result] ... — This option will install the selected test(s) inside the testing environment directory. The install process from downloading of the test files to the installation is fully automated. The install option needs to be supplied with the test name or suite as an argument. Optionally, a OpenBenchmarking.org ID or the name of a saved results file can be supplied as well and the test(s) to install will automatically be extracted from that information. If the test is already installed and was run by the latest version of the installation process, no action will be taken. Multiple arguments can be supplied to install additional tests at the same time. 📦
  • install-dependencies [Test | Suite | OpenBenchmarking ID | Test Result] ... — This option will install the external dependencies needed by the selected test(s) using the distribution's package management system. For example, some tests depend upon GCC for compiling code. If GCC is not detected on the system, the Phoronix Test Suite will attempt to install GCC using the distribution's package management system. If you are running this command as a local user, you may be prompted for the root password while the process is running. For unsupported distributions, the dependency names will be displayed along with common names for the package. The install-dependencies option needs to be supplied with the test name or suite as an argument. When using the install option, the external dependencies are automatically checked. 🔧
  • make-download-cache — This option will create a download cache for use by the Phoronix Test Suite. The download cache is created of test files already downloaded to the local system. If passing any test/suite names to make-download-cache, the needed files for those test profiles will first be automatically downloaded before creating the cache. 💾
  • remove-installed-test [Test] — This option will permanently remove a installed test by the Phoronix Test Suite. 🗑️

🧪 TESTING 🧪

  • benchmark [Test | Suite | OpenBenchmarking ID | Test Result] ... — This option will install the selected test(s) (if needed) and will proceed to run the test(s). This option is equivalent to running phoronix-test-suite with the install option followed by the run option. Multiple arguments can be supplied to run additional tests at the same time and save the results into one file. 🏁
  • estimate-install-time [Test | Suite | OpenBenchmarking ID | Test Result] — This option will provide estimates for test install/setup time length. ⏳
  • estimate-run-time [Test | Suite | OpenBenchmarking ID | Test Result] — This option will provide estimates for test run-time / length. ⌛
  • finish-run [Test Result] — This option can be used if a test run had not properly finished running all tests within a saved results file. Using this option when specifying a saved results file where all tests had not completed will attempt to finish / resume testing on the remaining tests where there are missing results to be completed. 🧩
  • run [Test | Suite | OpenBenchmarking ID | Test Result] ... — This option will run the selected test(s). 🏃‍♀️
  • run-random-tests — This option will query OpenBenchmarking.org to run random benchmarks and result comparisons on the system. This test can be used for simply supplying interesting results from your system onto OpenBenchmarking.org, stressing your system with random workloads, seeding new OpenBenchmarking.org results, etc. Basic options are provided at start-up for tuning the randomness of the testing when running this command. 🎲
  • run-subset [Test | Suite | OpenBenchmarking ID | Test Result] ... — This option will run the selected test(s) but prompt the user when passing any test suites or result files what subset / test(s) contained within there to run rather than running all passed tests/suites/results. 🎯
  • run-tests-in-suite [Suite] — This option can be used if you wish to run all of the tests found in a supplied suite, but you wish to re-configure each of the test options rather than using the defaults supplied by the suite. ⚙️
  • stress-batch-run [Test | Suite | OpenBenchmarking ID | Test Result] ... — This option will run the passed tests/suites in the multi-process stress-testing mode while behaving by the Phoronix Test Suite batch testing characteristics. The stress-batch-run mode is similar to the stress-run command except that for any tests passed to it will run all combinations of the options rather than prompting the user for the values to be selected. 🔥
  • stress-run [Test | Suite | OpenBenchmarking ID | Test Result] ... — This option will run the passed tests/suites in the multi-process stress-testing mode. The stress-run mode will not produce a result file but is rather intended for running multiple test profiles concurrently to stress / burn-in the system. The number of tests to run concurrently can be toggled via the PTS_CONCURRENT_TEST_RUNS environment variable and by default is set to a value of 2. 💀
  • strict-benchmark [Test | Suite | OpenBenchmarking ID | Test Result] ... — This option is equivalent to the benchmark option except it enables various options to run benchmarks an extended number of times for ensuring better statistical accuracy if enforcing strict controls over the data quality, in some cases running the benchmarks for 20+ times. 📊
  • strict-run [Test | Suite | OpenBenchmarking ID | Test Result] ... — This option is equivalent to the run option except it enables various options to run benchmarks an extended number of times for ensuring better statistical accuracy if enforcing strict controls over the data quality, in some cases running the benchmarks for 20+ times. 📈

🤖 BATCH TESTING 🤖

  • batch-benchmark [Test | Suite | OpenBenchmarking ID | Test Result] ... — This option and its arguments are equivalent to the benchmark option, but the process will be run in the Phoronix Test Suite batch mode. 🤖
  • batch-install [Test | Suite | OpenBenchmarking ID | Test Result] ... — If you wish to run the install process in the Phoronix Test Suite batch mode but do not wish to run any tests at this time. Running the install process in the batch mode will use the default values and not prompt the user of any possible options, to ensure the process is fully automated. 📥
  • batch-run [Test | Suite | OpenBenchmarking ID | Test Result] ... — This option and its arguments are equivalent to the run option, but the process will be run in the Phoronix Test Suite batch mode. 🏃‍♂️
  • batch-setup — This option is used to configure the batch mode options for the Phoronix Test Suite, which is subsequently written to the user configuration file. Among the options are whether to automatically upload the test results to OpenBenchmarking.org and prompting for the saved file name. ⚙️
  • default-benchmark [Test | Suite | OpenBenchmarking ID | Test Result] ... — This option will install the selected test(s) (if needed) and will proceed to run the test(s) in the defaults mode. This option is equivalent to running phoronix-test-suite with the install option followed by the default-run option. 🏁
  • default-run [Test | Suite | OpenBenchmarking ID | Test Result] ... — This option will run the selected test(s). The name of the test or suite must be supplied or the OpenBenchmarking.org ID or saved local file name. Multiple arguments can be supplied to run additional tests at the same time and save the results in a suite-like fashion. Unlike the normal run option, the default-run will not prompt the user to select from the available test options but will instead use the default options as automatically set by pts-core or the test profile. Use batch-run to automatically test all of the available options. 🌟
  • dry-run [Test | Suite | OpenBenchmarking ID | Test Result] ... — okay so bestie, this one pre-sets the Phoronix Test Suite batch run mode with enforcing of defaults to not save any results and other behavior intended for a dry/test run. It's primarily intended for testing/evaluation purposes, so you can vibe check without leaving a trace. 💅
  • internal-run [Test | Suite | OpenBenchmarking ID | Test Result] ... — this pre-sets the batch run mode with sane values for carrying out benchmarks in a semi-automated manner and without uploading any of the result data to the public OpenBenchmarking.org. Lowkey perfect for keeping your results private. 🫶

✨ OPENBENCHMARKING.ORG ✨

  • clone-result [OpenBenchmarking ID] ... — this will download a local copy of a file that was saved to OpenBenchmarking.org, as long as a valid public ID is supplied. So you need the ID, bestie. 💖
  • dump-suites-to-git — this will create a Git repository of OpenBenchmarking.org test suites. Slay. 🎀
  • dump-tests-to-git — this will create a Git repository of OpenBenchmarking.org test profiles. Git repo of test profiles, iconic. 🔥
  • enable-repo — used if you want to add a new OpenBenchmarking.org account/repository to your system for enabling third-party/unofficial test profiles and test suites. Basically unlocking the secret menu. 👑
  • list-recommended-tests — lists recommended test profiles for benchmarking sorted by hardware sub-system. The recommended tests are determined via querying OpenBenchmarking.org and determining the most popular tests for a given environment based upon the number of times a test profile has been downloaded, the number of test results available on OpenBenchmarking.org for a given test profile, the age of the test profile, and other weighted factors. So it's the algorithm's faves. ✨
  • make-openbenchmarking-cache — attempts to cache the test profile/suite meta-data from OpenBenchmarking.org for all linked repositories. Useful if you're running the Phoronix Test Suite / Phoromatic behind a firewall or without any Internet connection. Those with unrestricted Internet access or not utilizing a large local deployment of the Phoronix Test Suite / Phoromatic shouldn't need to run this command. Offline besties, this one's for you. 🧚
  • ob-test-profile-analyze — intended for test profile creators and generates a range of meta-data and other useful information that can be submitted to OpenBenchmarking.org to provide more verbose information for users of your test profiles. For the creators, periodt. 💅
  • openbenchmarking-changes — lists recent changes to test profiles of enabled OpenBenchmarking.org repositories. Stay updated. 🦋
  • openbenchmarking-login — used for controlling your Phoronix Test Suite client options for OpenBechmarking.org and syncing the client to your account. (Yes, the typo is in the original — we keep it fr fr.) 😭
  • openbenchmarking-refresh — used for refreshing the stored OpenBenchmarking.org repository information and other data. The Phoronix Test Suite will automatically refresh this data every three days or when other thresholds are exceeded, but this command can be used to manually refresh/updates the data. If you're impatient, here you go. 🔄
  • openbenchmarking-repositories — lists the OpenBenchmarking.org repositories currently linked to this Phoronix Test Suite client instance. See what you're connected to. 🌸
  • openbenchmarking-uploads — lists any recent test result uploads from the system's IP address to OpenBenchmarking.org. Peep your upload history. 👀
  • recently-added-tests — lists the most recently added (newest) test profiles. Fresh off the press. 🍓
  • upload-result [Test Result] — used for uploading a test result to OpenBenchmarking.org. Share your scores. 💜
  • upload-test-profile — used for uploading a test profile to your account on OpenBenchmarking.org. By uploading your test profile to OpenBenchmarking.org, others are then able to browse and access this test suite for easy distribution in a seamless manner by other Phoronix Test Suite clients. Share your creation. 🎀
  • upload-test-suite [Suite] — used for uploading a test suite to your account on OpenBenchmarking.org. By uploading your test suite to OpenBenchmarking.org, others are then able to browse and access this test suite for easy distribution. Suite sharing, slay. 💖

✨ INFORMATION ✨

  • info [Test | Suite | OpenBenchmarking ID | Test Result] — shows details about the supplied test, suite, virtual suite, or result file. Get the tea. ☕
  • intersect [Test | Suite | OpenBenchmarking ID | Test Result] ... — prints the test profiles present in all passed result files / test suites. Two or more results/suites must be passed and printed will be all of the common test profiles. Find the overlap. 🔍
  • list-all-tests — lists all test profiles that are available from the enabled OpenBenchmarking.org repositories. Unlike the other test listing options, list-all-tests will show deprecated tests, potentially broken tests, or other tests not recommended for all environments. The only check in place is ensuring the test profiles are at least compatible with the operating system in use. It's the wild west, bestie. ⚠️
  • list-available-suites — lists all test suites that are available from the enabled OpenBenchmarking.org repositories. 💅
  • list-available-tests — lists all test profiles that are available from the enabled OpenBenchmarking.org repositories where supported on the system and are of a verified state. If the system has no Internet access, it will only list the test profiles where the necessary test assets are available locally on the system or on an available network cache (the same behavior as using the list-cached-tests sub-command), unless using the list-all-tests option to override this behavior. The verified, supported ones. ✨
  • list-available-virtual-suites — lists all available virtual test suites that can be dynamically created based upon the available tests from enabled OpenBenchmarking.org repositories. Virtual suites, iconic. 🦋
  • list-cached-tests — lists all test profiles where any needed test profiles are already cached or available from the local system under test. This is primarily useful if testing offline/behind-the-firewall and other use-cases where wanting to rely only upon local data. Offline vibes. 🧚
  • list-installed-dependencies — lists all of the packages / external test dependencies that are already installed on the system that the Phoronix Test Suite may potentially depend upon by test profiles. Know your deps. 📦
  • list-installed-suites — lists all suites that are currently installed on the system. ✅
  • list-installed-tests — lists all test profiles that are currently installed on the system. ✅
  • list-missing-dependencies — lists all of the packages / external test dependencies that are missing from the system that the Phoronix Test Suite may potentially need by select test profiles. What you're missing. 😭
  • list-not-installed-tests — lists all test profiles that are supported and available but presently NOT installed on the system. The ones you haven't got yet. 🙈
  • list-possible-dependencies — lists all of the packages / external test dependencies that are are potentially used by the Phoronix Test Suite. (Double "are are" is in the original — keep it.) 😭
  • list-saved-results — lists all of the saved test results found on the system. Your trophy case. 🏆
  • list-test-status — provides a verbose look at all tests installed/uninstalled on the system and whether any errors were encountered at install-time or run-time and other test installation/runtime metrics for complementing other Phoronix Test Suite sub-command outputs. The full tea. ☕
  • list-test-usage — lists various details about installed tests and their usage. How are they being used? 👀
  • print-tests [Test | Suite | OpenBenchmarking ID | Test Result] ... — prints the test identifiers of the specified result file(s), test suite(s), OpenBenchmarking.org ID(s), or other runnable object(s). Get those IDs. 🔖
  • search — provides command-line searching abilities for test profiles / test suites / test results. The search query can be passed as a parameter otherwise the user is prompted to input their search query.. (Two periods, keep it.) Search away. 🔎
  • test-to-suite-map — lists all test profiles and any test suites each test belongs to. Mapping the connections. 🗺️

✨ ASSET CREATION ✨

  • build-suite — guides the user through the process of generating their own test suite, which they can then run. Optionally, passed as arguments can be the test(s) or suite(s) to add to the suite to be created, instead of being prompted through the process. Build your own suite, bestie. 🛠️
  • create-test-profile — can be used for creating a Phoronix Test Suite test profile by answering questions about the test for constructing the test profile XML meta-data and handling other boiler-plate basics for getting started in developing new tests. Make your own test. 💖
  • debug-benchmark [Test | Suite | OpenBenchmarking ID | Test Result] ... — intended for use by test profile writers and is identical to the run option but will yield more information during the run process that can be used to debug issues with a test profile or to verify the test profile is functioning correctly. 🔧
  • debug-install [Test | Suite | OpenBenchmarking ID | Test Result] ... — intended for use by test profile writers and is identical to the install option but will yield more information during the run process that can be used to debug issues with a test profile installer or to verify the test profile is functioning correctly. Same but for install. 🔧
  • debug-result-parser [Test | Suite | OpenBenchmarking ID | Test Result] ... — intended for use by test profile writers and is used for debugging a result parser. No test execution is done, but there must already be PTS-generated .log files present within the test's installation directory. You need the logs. 📄
  • debug-test-download-links [Test | Suite | OpenBenchmarking ID | Test Result] — checks all download links within the specified test profile(s) to ensure there are no broken URLs. No broken links, periodt. 🔗
  • download-test-files [Test | Suite | OpenBenchmarking ID | Test Result] — bestie this one just downloads the selected test file(s) into the Phoronix Test Suite download cache and then… stops. It does not install the tests. Just yeets the files into the cache and vibes. 🫶
  • dump-documentation — this option is for re-generating the Phoronix Test Suite documentation. Docs girlies, this one's for you 💅
  • inspect-test-profile [Test] — peek inside a Phoronix Test Suite test profile and get the inside details on it. It's giving debugging / evaluation / learning purposes. So if you wanna understand what a test profile is actually made of, this is your girl 🔍✨
  • rebuild-test-suite [Suite] — regenerates the local test suite XML file against the OpenBenchmarking.org specification. Basically a glow-up for your XML — use it to clean up any existing XML syntax / styling issues, etc. 🧼
  • validate-result-file — validates a Phoronix Test Suite result file and checks it's compliant against the OpenBenchmarking.org specification. Compliance check, periodt ✅
  • validate-test-profile [Test] — same energy, but for a Phoronix Test Suite test profile: validating it as compliant against the OpenBenchmarking.org specification.
  • validate-test-suite [Suite] — and again for a Phoronix Test Suite test suite: validating it as compliant against the OpenBenchmarking.org specification.

🌈 RESULT MANAGEMENT 🌈

  • auto-sort-result-file [Test Result] — use this when you want it to automatically attempt to sort the results by their result identifier string. And plot twist: if you set the environment variable SORT_BY, you can use other sort modes, like SORT_BY=date / SORT_BY=date-desc for sorting by the test run-time/date. Sorting queen 👑
  • compare-results-to-baseline [Test Result] [Test Result] — drop a result as your baseline (that's the first parameter) and a second result file (that's the second parameter), and it offers some analysis showing how the second result compares to the first in matching tests. Head-to-head but make it baseline 💖
  • compare-results-two-way [Test Result] — give it a result file and it'll compare two individual runs within that file, looking at wins/losses and other metrics in a head-to-head type comparison. Two runs enter, one analysis leaves 🔥
  • edit-result-file [Test Result] — wanna edit the title and description of an existing result file? Yeah. This one. ✏️
  • extract-from-result-file [Test Result] — pulls a single set of test results out of a saved results file that contains multiple test results that have been merged. Then it prompts you to specify a new result file name and select which result identifier to extract. Extraction slay 🎀
  • keep-results-in-result-file [Test Result] — this is literally the inverse of the remove-results-from-result-file sub-command. If you want to remove all results but those listed from a given result file, this is it. You specify a saved results file, and then you get prompted to provide a string to search for — keeping those results in that file while removing all other data. Keep the faves, drop the rest 💅
  • merge-results [Test Result] ... — manually merges multiple sets of test results generated by the Phoronix Test Suite. Combining timelines, multiverse style 🌌
  • prune-empty-results [Test Result] — for when there are test results (benchmarks) to be dropped from a given result file because they had no successful runs. I.e. if any run attempt(s) only errored out without producing any result for any of the test run(s) saved in that file. You must specify a saved results file. Bye to the empty ones 👋
  • prune-extra-data [Test Result] — removes any extra/erroneous data from appearing if any duplicate result entries or other data shows up within a saved result file. Ngl this one is typically only used for testing or for encountering any errored result files. 🧹
  • prune-zero-data [Test Result] — for when there are test results (benchmarks) where there is line graph data that currently has zero values (e.g. inaccurate/invalid sensor readings) and you wish to just drop those zero reading values from the result file. Zeroes, be gone 💀
  • remove-incomplete-results-from-result-file [Test Result] — drops test results (benchmarks) from a given result file for having incomplete data — either a test run did not attempt to run that benchmark or it failed to properly run. You specify a saved results file, and the command then attempts to find any results with incomplete/missing data and prompts you with confirmation to remove them. Confirmation, because we're polite 🫶
  • remove-result [Test Result] — permanently removes the saved file set that is set as the first argument. And bestie, permanently means permanently. 🚨
  • remove-result-from-result-file [Test Result] — for when there are test results (benchmarks) to be dropped from a given result file. You specify a saved results file, and then you get prompted to select the tests/benchmarks to remove. Hand-picked removal, iconic 🎀
  • remove-results-from-result-file [Test Result] — also for when there are test results (benchmarks) to be dropped from a given result file. You specify a saved results file, and then you get prompted to provide a string to search for in removing those results from that given result file. Search-and-destroy, but cute 🔍
  • remove-run-from-result-file [Test Result] — if there's a set of test results you want to remove/delete from a saved results file, this is the one. You specify a saved results file, and then you get prompted to select the results identifier associated with the results you wish to remove. 🗑️
  • rename-identifier-in-result-file [Test Result] — changes the name of the identifier in a test results file that's shown in the Phoronix Test Suite Results Viewer and the contained graphs. A little rebrand never hurt anybody ✨
  • rename-result-file [Test Result] — changes the name of the saved name of a result file. Name change era 💅
  • reorder-result-file [Test Result] — manually changes the order in which test results are shown in the Phoronix Test Suite Results Viewer and the contained graphs. You specify a saved results file, and then you get prompted to select the results identifiers one at a time in the order you'd like them displayed, from left to right. Choreographing your graphs 🩰
  • show-result [Test Result] — opens up the test results in the Phoronix Test Suite Result Viewer or on OpenBenchmarking.org. Go look at your numbers, main character 👑

🌈 OTHER 🌈

  • commands — displays a short list of possible Phoronix Test Suite commands. A little menu moment 🍓
  • debug-dependency-handler — used for testing the distribution-specific dependency handler for external dependencies. Debug girlies rise 🛠️
  • debug-render-test — used during the development of the Phoronix Test Suite software for testing of the result and graph rendering code paths. Heads up: this option will download a large number of reference test results from LinuxBenchmarking.com. 📊
  • debug-self-test — used during the development of the Phoronix Test Suite software for testing of internal interfaces, commands, and other common code paths. Important caveat: the produced numbers should only be comparable for the same version of the Phoronix Test Suite, on the same hardware/software system, conducted on the same day of testing. This isn't intended as any scientific benchmark — it's simply to stress common PHP code paths and to look for hot areas to optimize, etc. So don't @ me with these numbers 😭
  • help — displays a list of available Phoronix Test Suite commands and possible parameter types. When in doubt, ask for help 🫶
  • version — displays the Phoronix Test Suite client version. ✨

🌈 RESULT ANALYSIS 🌈

  • analyze-run-times [Test Result] — reads a saved test results file and prints the statistics about how long the testing took to complete. Time math, but make it graph-adjacent ⏱️
  • executive-summary [Test Result] — attempts to auto-generate a textual executive summary for a result file to highlight prominent results / averages. TL;DR, generated for you 💅
  • result-file-confidence [Test Result] — reads a saved test results file and displays various statistics on the confidence of the results, with the standard deviation, three-sigma values, and other metrics — while color-coding "passing" results in green. Vibe check: passed ✅
  • result-file-stats [Test Result] — analyzes a result file by showing various statistics on the result data, for result files containing at least two sets of data. Two or more, or it's not happening 🔢
  • wins-and-losses [Test Result] — analyzes a result file to see which runs produced the most wins/losses of those result identifiers in the saved file. Leaderboard energy 🏆
  • workload-topology [Test Result] — reads a saved test results file and prints the test profiles contained within, plus their arrangement within different test suites, so you can get an idea as to the workload topology / make-up / logical groupings of the benchmarks being run. It's giving map of your whole workload 🗺️

🌈 MODULES 🌈

  • auto-load-module — easily adds a module to the AutoLoadModules list in the Phoronix Test Suite user configuration file. That list controls what PTS modules are automatically loaded on start-up of the Phoronix Test Suite. Autoload era, no manual clicking 🙈
  • list-modules — lists all of the available Phoronix Test Suite modules on this system. 📋
  • module-info [Phoronix Test Suite Module] — shows detailed information on a Phoronix Test Suite module, such as the version, developer, and a description of its purpose. Getting to know you 💖
  • module-setup [Phoronix Test Suite Module] — lets you configure all available end-user options for a Phoronix Test Suite module. Those options are then stored within the user's configuration file. Heads up though: not all modules may have options that can be configured by the end-user. 🎛️
  • test-module [Phoronix Test Suite Module] — can be used for debugging a Phoronix Test Suite module. 🐛
  • unload-module — bestie, this one is your little ✨declutter✨ button. It yanks a module right out of the AutoLoadModules list in the Phoronix Test Suite user configuration file. And what even is that list?? It's the list that decides which modules get auto-loaded every time the Phoronix Test Suite boots up. So yeah, it's the guest list, and this option is the bouncer. 💅

🐛 DEBUGGING 🐛

Okay so this whole section is for when things go feral and you need to snoop. Detective mode: ACTIVATED. 🔍

  • check-tests [Test] — drop one or more test profiles in here and it'll run a check on them to see if any vendor went and changed stuff behind your back: the filename, the filesize, the URL location, the MD5 checksum, the SHA256 checksum. Basically it's the vibe check for whether your test data still matches what it's supposed to be. 🕵️‍♀️
  • diagnostics — this prints out info that's genuinely useful to developers when they're debugging problems with the Phoronix Test Suite itself, and/or with test profiles and test suites. It's giving "here's everything, go figure it out." 🩺
  • dump-file-info — hands you the MD5 / SHA256 checksums plus the file size for a file you point it at. Simple. Iconic. No notes. 🎀
  • dump-openbenchmarking-indexes — this one dumps out the parsed output of OpenBenchmarking.org index files (a.k.a. the metadata). Parsed, dumped, done. 🗂️
  • dump-phodevi-smart-cache — shows you the actual contents of the Phodevi smart cache living on your system. Peek inside, bestie, it's fine. 👀
  • dump-possible-options — prints out every single possible phoronix-test-suite sub-command. All of them. The whole roster. 👑
  • dump-unhandled-dependencies — lists the missing entries in the external dependencies XML file for whatever operating system you're testing on. Why would you want this?? Because it's the option you use when you wanna help find missing dependency XML data so you can contribute it upstream to the Phoronix Test Suite. Contributing?? We love to see it. 🫶
  • list-failed-installs — lists every test profile that was attempted to be installed on your local system and then flopped. 😭 And where it applies, it also reports the possible error(s) from that test installation to help you debug. So you get receipts, not just a sad list.
  • list-test-errors — okay so this sub-command is the sibling of list-failed-installs, but with a plot twist: instead of showing install errors, it shows you past test run-time errors. It lists all the test profiles that produced an error previously when the test profile / benchmark was running. And here's the cute part — if a test profile later successfully runs with any given option(s) and no errors, that error gets removed from the archive. It's for debugging test profile issues later on, keeping a persistent collection of run-time errors so future-you isn't confused. Growth. 🌱
  • list-unsupported-tests — lists all the available test profiles sitting in your enabled OpenBenchmarking.org repositories that are NOT SUPPORTED on the given hardware/software platform. It's mainly a debugging option for people hunting for test profiles to potentially port over to new platforms, etc. Porting arc?? Slay. 🌈

⚙️ USER CONFIGURATION ⚙️

  • enterprise-setup — this one is for enterprise users and you run it right after package installation, or just fold it into an in-house setup script. Running this command makes sure the phoronix-test-suite program is never interrupted on new runs to accept user agreement changes. It also defaults the anonymous usage reporting to disabled, along with other conservative settings. Set it and forget it, corporate bestie. 💼✨
  • network-info — prints out the information the Phoronix Test Suite detected about your system's network configuration. 🌐
  • network-setup — lets you configure how the Phoronix Test Suite connects to OpenBenchmarking.org and other web-services. And yes — connecting through an HTTP proxy can be configured right here. Proxy girlies, this one's for you. 🧚
  • user-config-reset — resets the Phoronix Test Suite user configuration file back to its default state. Clean slate energy. 🧼
  • user-config-set — used for setting an XML value inside the Phoronix Test Suite user configuration file. Precise. Surgical. 💅
  • variables — prints out all of the official environment variables supported by the Phoronix Test Suite for user configuration purposes. These same environment variables are also listed in the official Phoronix Test Suite documentation, and on top of that, this command will show you the current value of each variable if it's currently set. Two-for-one. 🔥

📤 RESULT EXPORT 📤

  • result-file-raw-to-csv [Test Result] — reads a saved test results file and outputs the raw result file run data to a CSV file. Heads up though: this raw (individual) result file output is intended for data analytic purposes, whereas result-file-to-csv is the more end-user-ready one. Pick your fighter. 📊
  • result-file-to-csv [Test Result] — reads a saved test results file and outputs the system hardware and software information along with the results into a CSV output (Comma Separated Values) file. Then you can load that file into a spreadsheet for easy viewing, which, honestly, obsessed. The outputted file appears in the user home directory, or you can control it via the OUTPUT_DIR and OUTPUT_FILE environment variables. 🗃️
  • result-file-to-html [Test Result] — reads a saved test results file and outputs the system hardware and software information along with the results into a pure HTML file. No external files are required for CSS/JavaScript or other assets — the graphs are rendered as inline SVG. It's a pure HTML-only representation of the results, perfect for emailing or for easy analysis outside of the Phoronix Test Suite. The outputted file appears in the user home directory, or you can control it via the OUTPUT_DIR and OUTPUT_FILE environment variables. 💖
  • result-file-to-json [Test Result] — reads a saved test results file and outputs the basic result information to JSON (JavaScript Object Notation). The outputted file appears in the user home directory, or you can control it via the OUTPUT_DIR and OUTPUT_FILE environment variables. ✨
  • result-file-to-pdf [Test Result] — reads a saved test results file and outputs the system hardware and software information along with the results into a PDF file. The outputted file appears in the user home directory, or you can control it via the OUTPUT_DIR and OUTPUT_FILE environment variables. 📄
  • result-file-to-suite [Test Result] — this one walks you through making your own test suite, based on an existing test results file, which you can then go run. Main character move, tbh. 👑
  • result-file-to-text [Test Result] — reads a saved test results file and outputs the system hardware and software information straight to the terminal. And yes, the test results get outputted too. 🖥️

🎛️ PHOROMATIC 🎛️

  • start-phoromatic-server — starts the Phoromatic web server, which controls local Phoronix Test Suite client systems so you can do automated and repeated test orchestration, plus other automated features targeted at the enterprise. Very "I run a whole fleet now" of it. 🏢💅

👀 RESULT VIEWER 👀

n _

okay bestie that is genuinely all it says there, no cap. moving on 🫠

🔗 SEE ALSO 🔗

Websites:

👑 AUTHORS 👑

Copyright 2008 - 2025 by Phoronix Media, Michael Larabel. 📝

and that's a wrap on the whole page, bestie!! 🎀 that footer down at the bottom is where the source/version and the date hang out — you know, the little "this is the phoronix-test-suite manual page, from this version, dated this" moment. now go forth and benchmark something iconic ✨🦋💜

📦 where this page comes from