Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Available Command-Line Flags

The Scalionix System Benchmark exposes all configurable behavior through command-line flags.

Every flag controls a specific aspect of benchmark execution.

Unless explicitly stated otherwise, command-line flags are independent and may be combined freely.

The following sections describe every supported flag in detail.

--output

Purpose

Specifies the directory where benchmark reports will be written.

Syntax

--output <directory>

Example

scalionix-system-benchmark \
    --output ./benchmarks

Description

If the directory does not exist, it is created automatically.

All generated benchmark reports are written into this directory.

Typical generated files include:

  • Full Benchmark Report
  • Scoring Report
  • Global Score Report

Default Value

Current working directory.

Notes

Changing the output directory does not affect benchmark execution.

Only report locations are modified.


--benchmark-work-dir

Purpose

Specifies the working directory used for temporary benchmark data.

Syntax

--benchmark-work-dir <directory>

Example

scalionix-system-benchmark \
    --benchmark-work-dir /mnt/nvme0/benchmark-work

Description

Benchmark datasets are created inside this directory.

Storage benchmarks execute directly against this location.

Compilation fixtures are extracted here before compilation begins.

The benchmark automatically creates and removes temporary benchmark files when appropriate.

Default Value

Platform-specific temporary benchmark directory.

Notes

The selected working directory directly influences Storage benchmark results because it determines which storage device is evaluated.


--report-id

Purpose

Assigns a custom identifier to the benchmark execution.

Syntax

--report-id <identifier>

Example

scalionix-system-benchmark \
    --report-id workstation-7950x3d-linux

Description

The Report ID is stored inside every generated report.

Typical Report IDs include:

  • workstation-001
  • build-server
  • laptop-arm64
  • benchmark-2026-08

Default Value

Automatically generated UUID Version 7.

Notes

Report IDs are intended to identify benchmark executions rather than hardware.


--user-id

Purpose

Associates benchmark reports with a specific user.

Syntax

--user-id <identifier>

Example

scalionix-system-benchmark \
    --user-id john-doe

Description

The User ID becomes part of every generated report.

Future Global Ranking services use this value to associate benchmark results with benchmark owners.

Default Value

Platform-specific default user identifier.

Notes

Changing the User ID never influences benchmark scores.

It serves only as report metadata.


--check-hardware

Purpose

Detects hardware and prints the complete Hardware Snapshot.

Syntax

--check-hardware

Example

scalionix-system-benchmark \
    --check-hardware

Description

The benchmark detects hardware exactly as it would before normal execution.

The Hardware Snapshot is printed to standard output.

Benchmark execution does not begin.

Typical information includes:

  • Processor
  • Memory
  • Storage devices
  • Benchmark storage
  • Operating system
  • Hardware fingerprint

Exit Status

Success after printing hardware information.

Notes

Useful for validating hardware detection before executing the benchmark.


--setup-compilation-environment

Purpose

Verifies the software environment required by the Compilation benchmark.

Syntax

--setup-compilation-environment

Example

scalionix-system-benchmark \
    --setup-compilation-environment

Description

The benchmark verifies the availability of all required compilation tools.

Current verification includes:

Rust

  • cargo
  • rustc
  • rustup

C++

Linux
  • g++
  • make
  • build-essential (or equivalent)
macOS
  • clang++
  • Xcode Command Line Tools

The benchmark reports:

  • Installed tools
  • Detected versions
  • Missing components
  • Installation recommendations

Benchmark execution does not begin.

Exit Status

Success if the environment satisfies benchmark requirements.

Notes

This command verifies the environment.

It does not automatically install missing software.


--compare-score

Purpose

Compares two previously generated Global Score Reports.

Syntax

--compare-score

Required Companion Flags

  • --baseline
  • --candidate

Example

scalionix-system-benchmark \
    --compare-score \
    --baseline old-score.json \
    --candidate new-score.json

Description

The benchmark loads both reports.

Compatibility is verified.

Category scores are compared.

Compute and Storage Scores are compared.

Percentage differences are calculated.

Benchmark execution is skipped.

Exit Status

Success after comparison completes.


--baseline

Purpose

Specifies the baseline Global Score Report.

Syntax

--baseline <file>

Example

--baseline benchmark-old.json

Description

The specified report becomes the reference against which the candidate report is evaluated.

This flag has meaning only when used together with:

  • --compare-score

--candidate

Purpose

Specifies the benchmark report being evaluated.

Syntax

--candidate <file>

Example

--candidate benchmark-new.json

Description

The candidate report is compared against the baseline report.

This flag has meaning only when used together with:

  • --compare-score

Flag Combination Rules

Certain command-line flags are intended to be used together.

Hardware Detection

scalionix-system-benchmark \
    --check-hardware

Compilation Environment Verification

scalionix-system-benchmark \
    --setup-compilation-environment

Benchmark Comparison

scalionix-system-benchmark \
    --compare-score \
    --baseline score-a.json \
    --candidate score-b.json

Custom Output Directory

scalionix-system-benchmark \
    --output ./benchmarks

Benchmark Execution

scalionix-system-benchmark \
    --report-id workstation-linux \
    --user-id john \
    --output ./benchmarks

The benchmark validates incompatible flag combinations before execution begins.

Design Summary

The command-line interface has been designed to expose every important benchmark capability through explicit, deterministic, and automation-friendly flags.

Rather than relying on hidden configuration files or interactive prompts, every benchmark parameter is fully controlled through the command line.

This design ensures predictable execution, straightforward scripting, seamless integration with continuous integration systems, and long-term reproducibility of benchmark results.

Scalionix Docs

Keyboard Shortcuts

Navigate the documentation without leaving the keyboard.
Navigation
Previous subject
←
Next subject
→
Previous subsection
Alt + ↑
Next subsection
Alt + ↓
Interface
Documentation Home
Ctrl + Enter
Search
Alt + Q
Open shortcuts
?
Close dialog
Esc
Scalionix Docs

Search Documentation