PBE-REPORT(1)

👑 PBE — the pbe report command, bestie edition 👑

okay so hi, welcome to the PBE manual page 💖 this one's all about pbe report, and ngl it's kind of a slay. it takes your test results and turns them into a whole gorgeous HTML report. periodt.

✨ COMMAND pbe report ✨

here's the vibe, the whole entire usage line, character for character:

pbe report [-h] [-q] [-d] [-o OUTDIR] [--reportids REPORTIDS]
[--report-descr REPORT_DESCR] respaths [respaths ...]

Create an HTML report for one or multiple test results. that's it, that's the main character energy right there 🦋

🌸 ARGUMENTS 🌸

• respaths — one or multiple pbe test result paths. give me one, give me a hundred, I'm not judging 🫶

🎀 OPTIONS pbe report 🎀

one bullet per flag, no skipping, no cap:

• -h — show this help message and exit. the classic. the icon ✨
• -q — be quiet. shhh 🤫
• -d — print debugging information. for when you're nosy (affectionate) 🔍
• -o OUTDIR, --outdir OUTDIR — path to the directory to store the report at. by default the report is stored in the pbe-report-<reportid> sub-directory of the test result directory. but if there are multiple test results, the report is stored in the current directory instead. and the <reportid> in that path? that's the report ID of the pbe test result 💅
• --reportids REPORTIDS — okay so every input raw result comes with a report ID. this report ID is basically a short name for the test result, and it's used in the HTML report to refer to the test result. however (yes, however), sometimes it's helpful to temporarily override the report IDs just for the HTML report, and that is exactly what --reportids does. please specify a comma-separated list of report IDs for every input raw test result. the first report ID will be used for the first raw test result, the second report ID will be used for the second raw test result, and so on and so on forever 🌈
• --report-descr REPORT_DESCR — the report description: any text describing this report as a whole, or a path to a file containing the overall report description. for example, if the report compares platform A and platform B, the description could be something like platform A vs B comparison. this text gets included into the very beginning of the resulting HTML report. opening act behavior, honestly 🎤

bestie heads up: for the full lore on what a report ID even is, go read the --reportid option description over in the start command. iykyk 📖

xoxo, that's the whole page 💜 this was PBE manual, dated 2024-05-28 — go make a cute report, you got this 🧚🌸