CLI

Command line

The blocks below are plugii … --help exactly as clap prints it: a test renders each one into an insta snapshot, and this page shows those snapshots, so it changes when the code does. Getting started has the exit codes.

plugii

The report. With no flags, the full report and health verdict; -H the verdict only; --json the snapshot and findings as JSON (and wins over -H); --firmware adds the firmware checks to any of them.

$ plugii --help

Live Linux USB port monitor: which socket, what link speed, USB-C / PD power

Usage: plugii [OPTIONS]
       plugii <COMMAND>

Commands:
  watch    Live view: updates as devices, chargers and displays come and go
  capture  Copy the sysfs files plugii reads into DIR, as a test fixture
  replay   Play back a file written by `watch --record`
  labels   List the labels file's sockets, peers, USB-C ports and devices
  help     Print this message or the help of the given subcommand(s)

Options:
  -H, --health    Health verdict only
      --json      Print the snapshot as JSON
      --firmware  Also check firmware versions (DMI, fwupd, vendor catalogs; uses the network)
      --refresh   With --firmware: fetch the vendor catalog even if a cached copy is fresh
  -w, --watch     Same as `plugii watch`
  -h, --help      Print help
  -V, --version   Print version

--refresh needs --firmware; -w can’t combine with the report flags; flags and a command can’t be mixed. Each of those is a usage error (exit 2).

plugii watch

The live TUI; see The TUI and, for the recording flags, Record and replay.

$ plugii watch --help

Live view: updates as devices, chargers and displays come and go

Usage: plugii watch [OPTIONS]

Options:
      --record <FILE>  Also record every snapshot to FILE as JSON lines (gzip-compressed when FILE ends in .gz), for `plugii replay`
      --redact         Replace device serial numbers and Thunderbolt unique IDs in the recording with REDACTED
      --force          Overwrite FILE if it exists
  -h, --help           Print help

plugii replay

$ plugii replay --help

Play back a file written by `watch --record`

Usage: plugii replay [OPTIONS] <FILE>

Arguments:
  <FILE>  

Options:
      --speed <SPEED>  Playback speed: 1, 2, 4, 10, 30 or 60 (`+` / `-` change it) [default: 1]
  -h, --help           Print help

Any other --speed is a usage error.

plugii labels

Prints the labels file’s path and what it names, by kind; see Labels.

$ plugii labels --help

List the labels file's sockets, peers, USB-C ports and devices

Usage: plugii labels

Options:
  -h, --help  Print help

plugii capture

Copies the sysfs and procfs files plugii reads into DIR (which must not exist yet), laid out as under /, so plugii can read the copy as if it were the machine; a CAPTURE.txt notes the date, kernel and model. Serial numbers and unique IDs are replaced with REDACTED, since captures end up in a public repository: contributors use it to turn a machine’s odd state into a fixture under tests/fixtures/sysfs/.

$ plugii capture --help

Copy the sysfs files plugii reads into DIR, as a test fixture

Usage: plugii capture <DIR>

Arguments:
  <DIR>  

Options:
  -h, --help  Print help

TUI keymap Labels file