Getting Help

You can use the -h/--help option to get help for the available commands and options when using the CLI:

  USAGE:
    sputter.exe [filter] [OPTIONS]

ARGUMENTS:
    [filter]

OPTIONS:
    -h, --help                Prints help information
    -v, --version             Prints version information
        --scrutiny-api
        --mqtt-server
        --mqtt-credentials

The default command will discover any local drives using the default adapters and gather measurements from all of them.

Drive Filter

If you only want to gather measurements from a subset of drives you can provide a filter. Filters can work a little different for each adapter but the usual behaviour is a basic wildcard match against detected drive’s serial number and model number. That is, if you provide a filter like "Z52*", Sputter will only gather measurements for drives where the serial number or model number starts with Z52

Scrutiny Support

You can add the API address of a Scrutiny server to gather measurements from a remote Scrutiny server (in addition to any local drives). Specify the full URL to the API address of your Scrutiny server:

  # For example:
sputter.exe --scrutiny-api "http://192.168.0.100:8080/api/"
# or
sputter.exe --scrutiny-api "https://scrutiny.domain.tld/api/"

MQTT

You can also publish any measurements the CLI finds (both local drives and from Scrutiny, if configured) to an MQTT broker. Note that this will be a one-time/“fire-and-forget” publish. To enable MQTT, you need to at least provide the --mqtt-server option:

  sputter --mqtt-server my-mqtt-server:1337
# or
sputter --mqtt-server "192.168.0.90"

If your MQTT server also requires authentication, you can provide credentials with the --mqtt-credentials option. For example:

  sputter --mqtt-server my-mqtt-server:1337 --mqtt-credentials "user:password"

Running this will still display any gathered measurements as usual, but now results will also be published to your MQTT broker.

Plugins

If you are using any Sputter plugins, unpack them into folders in a plugins folder in the same directory as the binary. For example, for the LibreHardwareMonitor plugin:

  │   sputter.exe
└───plugins
	└───Sputter.LibreHardwareMonitor
		│   // trimmed for brevity
		│   Sputter.Composition.dll
		│   Sputter.Core.dll
		│   Sputter.LibreHardwareMonitor.deps.json
		│   Sputter.LibreHardwareMonitor.dll
		└───runtimes
			└─── // trimmed