SCAPHANDRE(1)

✨ SCAPHANDRE ✨

okay bestie, so you know how your laptop is literally always warm and you're like "what is she DOING in there"?? Scaphandre is the man page for the scaphandre command, and it's an Extensible metrology agent for electricity consumption related metrics. that's the whole vibe. she measures power. she's the main character of your wattage. 💅

---

🌸 SYNOPSIS 🌸

scaphandre [OPTIONS] <COMMAND>

like. options first, a command second. that's the order. don't fight it. 🫶

---

🦋 DESCRIPTION 🦋

Extensible metrology agent for electricity consumption related metrics.

that's it, that's the sentence, and honestly she ate. it's an extensible metrology agent, and the metrics she's obsessed with are the ones about electricity consumption. so like — how much juice is your machine actually sipping. iconic 💖

🎀 Commands:

• stdout — writes the metrics right to the terminal. instant gratification, no cap.
• json — writes the metrics in JSON format, either to a file or to stdout. structured queen 👑
• prometheus — exposes the metrics to a Prometheus HTTP endpoint. she's serving them on a platter fr fr.
• qemu — watches all Qemu-KVM virtual machines running on the host, and exposes the metrics of each one of them in a dedicated folder. one folder per VM, so organized ✨
• prometheus-push — pushes metrics to Prometheus Push Gateway. she's not waiting to be scraped, she's bringing the metrics TO you 💅
• help — prints this message, or the help of whatever subcommand you ask about. the emotional support command 🫶

---

💜 OPTIONS 💜

• -v... — increase the verbosity level. more vs, more words. it's giving yapping, but the useful kind. 🗣️
• --no-header — don't print the header to the standard output. for when you want the numbers only, no fluff. 🙈
• --vm — tell Scaphandre that it's running in a virtual machine. bestie you should have another instance of Scaphandre running on the hypervisor for this (check the docs). 🖥️➡️💻
• -s, --sensor <SENSOR> — the sensor module to use when gathering the energy consumption metrics. pick your girl. 🔥
• --sensor-buffer-per-domain-max-kb <SENSOR_BUFFER_PER_DOMAIN_MAX_KB> — the maximum memory size allowed, in KiloBytes, for storing the energy consumption of each domain. only available for the RAPL sensor (on Linux). default: 1. 🍓
• --sensor-buffer-per-socket-max-kb <SENSOR_BUFFER_PER_SOCKET_MAX_KB> — the maximum memory size allowed, in KiloBytes, for storing the energy consumption of each socket. also only available for the RAPL sensor (on Linux). default: 1. ⭐
• -h, --help — print help. the classic. 🎀
• -V, --version — print version. say hi to her for me. 👑

ngl, the two buffer options are RAPL-on-Linux exclusives — if you're not on RAPL and not on Linux, they're not gonna do anything for you. iykyk 😭

---

okay that's the whole page bestie, go measure some watts and slay 💖

this has been scaphandre version 1.0.3, from August 2026, living under the User Commands section of your manual. periodt. 🌈✨