CLI Reference

usage: rpi-mqtt-monitor [-h] [-H] [-d] [-s] [-v] [-u] [-w] [-c] [--uninstall]

Monitor CPU load, temperature, frequency, free space, etc., and publish the
data to an MQTT server or Home Assistant API.

options:
  -h, --help       show this help message and exit
  -H, --hass_api   send readings via Home Assistant API (not via MQTT)
  -d, --display    display values on screen
  -s, --service    run as a service; sleep interval set in config.py
  -v, --version    display installed version and exit
  -u, --update     update script and config then exit
  -w, --hass_wake  display Home Assistant wake-on-LAN configuration
  -c, --config     open the interactive TUI configurator and exit
  --uninstall      uninstall rpi-mqtt-monitor and remove all related files

Options at a glance

FlagDescription
-h, --helpShow the help message and exit
-H, --hass_apiSend readings via the Home Assistant API (not via MQTT)
-d, --displayDisplay values on screen
-s, --serviceRun as a service; sleep interval set in config.py
-v, --versionDisplay installed version and exit
-u, --updateUpdate script and config then exit
-w, --hass_wakeDisplay Home Assistant wake-on-LAN configuration
-c, --configOpen the interactive TUI configurator (navigate with arrows, edit, save) and exit
--uninstallUninstall rpi-mqtt-monitor and remove all related files

Interactive configurator

Run rpi-mqtt-monitor --config to open a terminal UI for editing config.py. Move through the settings with the ↑/↓ arrows; each setting shows its description and default value. Press Enter to edit the selected value, s to save, and q to quit. Comments, ordering, and formatting in config.py are preserved.

Interactive TUI configurator