Skip to main content

homelab-nut detect

homelab-nut detect​

Scan nut-server host(s) for connected UPS hardware (nut-scanner)

Synopsis​

Connects over SSH to a nut-server host and runs nut-scanner to detect the connected UPS and the driver NUT should use for it. With no argument, every host with the nut-server role is scanned.

By default detect is read-only: it reports what's connected and the recommended driver. Pass --write to persist the detected driver into the inventory (only when exactly one UPS is found, to avoid guessing).

nut-scanner ships with the NUT package, which 'homelab-nut apply' installs — so a brand-new host must be applied once before detect can see anything.

With -o json, output is a JSON array suitable for AI agents and scripts.

homelab-nut detect [host] [flags]

Options​

-h, --help help for detect
-o, --output string output format: text (human) | json (machine-readable for AI/scripts) (default "text")
--write persist the detected driver into the inventory (single-UPS hosts only)

Options inherited from parent commands​

-i, --inventory string path to the inventory YAML file (default: ./homelab-nut.yaml if present, else ~/homelab-nut.yaml)

SEE ALSO​

  • homelab-nut - Modern CLI + TUI for Network UPS Tools (NUT)
Auto generated by spf13/cobra on 24-Jun-2026​