Command line

This page is generated from pcmp 1.0.2’s own clap definitions (pcmp --help).

Usage

pcmp [OPTIONS] <DATA>

Arguments

Argument	What it does
<DATA>	the data file, .json or .toml

Options

Option	What it does
-o, --out <DIR>	where the PNGs go, made if missing [default: .]
-k, --kind <KIND>	which charts to draw [default: all] [possible values: all, paired, ratio, bars]
-h, --help	Print help
-V, --version	Print version

Output

Each chart is written to <DIR>/<the data file's stem>-<kind>.png, overwriting one already there, and its path is printed on its own line on stdout. With several parties, --kind bars writes one chart per party, <stem>-bars-<party>.png. The data file’s fields are in Formats.

Exit codes

Code	When
0	Every chart was drawn.
1	The data file couldn’t be read or drawn, or a PNG couldn’t be written: one line on stderr starting pcmp: , naming the file and, where it can, the field, line and column.
2	The command line is wrong: clap’s error: …, the usage line and For more information, try '--help'. on stderr. A bare pcmp answers this way too.

Full help

Draws comparison charts as PNGs from a JSON or TOML data file

Usage: pcmp [OPTIONS] <DATA>

Arguments:
  <DATA>  the data file, .json or .toml

Options:
  -o, --out <DIR>    where the PNGs go, made if missing [default: .]
  -k, --kind <KIND>  which charts to draw [default: all] [possible values: all, paired, ratio, bars]
  -h, --help         Print help
  -V, --version      Print version

The data file is JSON or TOML (by its extension, else by its first character):

  title = "DECODE SPEED"
  unit = "FRAMES PER SECOND"
  better = "higher"                  higher or lower
  subtitle = "RYZEN 9 7950X"          optional, like date, notes, suffix
  date = "2026-10-11"
  suffix = " FPS"
  notes = ["* NOT LIKE FOR LIKE."]
  parties = [{ name = "OURS" }, { name = "THEIRS" }]

  [[groups]]
  name = "CPU"
  rows = [{ label = "H.264 1080P", values = [412, 298], mark = "*" }]

Each PNG is written to <out>/<data file's stem>-<kind>.png and its path printed.
With --kind all, one party draws bars; two or more draw the paired and ratio charts.
The README at https://github.com/gmrdad82/pito-compare has every field.