STATS-COLLECT-REPORT(1)

✨ stats-collect-report(1) — the REPORT() page ✨

okay so bestie, welcome to stats-collect-report 💖 this is the manual page for the report command, and she is literally the one who turns your test results into a cute little HTML report. no cap.

🌸 SYNOPSIS 🌸

stats-collect report [-h] [-q] [-d] [-o OUTDIR] [--reportids REPORTIDS] [--copy-raw] respaths [respaths ...]

🦋 DESCRIPTION 🦋

Command 'report' ✨

She makes an HTML report for one or multiple test results. that's the whole vibe. that's her job. she ate.

• respaths — one or multiple stats-collect test result paths. yeah, you can hand her a whole lil pile of them.

💅 OPTIONS 💅

🎀 General options 🎀

• -h — show this help message and dip. 👋
• -q — be quiet. shhh. 🤫
• -d — print debugging information. for when you need the tea. 🍵
• -o OUTDIR, --outdir OUTDIR — the path to the directory where the report gets stored. so like, by default the report goes in the 'stats-collect-report-<reportid>' sub-directory of the test result directory. but if you've got multiple test results, she puts the report in the current directory instead. and the '<reportid>' there? that's the report ID of the stats-collect test result. iykyk.
• --reportids REPORTIDS — okay so every input raw result comes with a report ID. that report ID is basically a short lil name for the test result, and it's what gets used in the HTML report to refer to that test result. but sometimes it's helpful to temporarily override the report IDs just for the HTML report, and that's exactly what '--reportids' does. please specify a comma-separated list of report IDs, one for every input raw test result. first report ID → first raw test result, second report ID → second raw test result, and so on and so on. for more info about the report ID itself, go peek at the '--reportid' option description in the 'start' command. 👑
• --copy-raw — copy raw test results to the output directory (unless the output direcory is already part of the raw result sub-directory). 🫶
• --cpus CPUS — the CPU numbers to include in the report, along with the system-wide statistics. by default, only the system-wide statistics are included. CPU numers should be specified as a comma-separated list of integers or integer ranges. for example, '1-4,7,8,10-12' would mean CPUs 1 to 4, CPUs 7, 8, and 10 to 12. iconic range notation fr fr. 🔥

heads up bestie: --cpus shows up down here in the options even though it's not in the usage line up top. just so you're not confused. 💀

and that's the whole page, bestie 🌈 this one's from the REPORT() manual, dated 25-03-2024, and it lives in the stats-collect world. go make some gorgeous reports, mwah 💖🎀✨