mqttui-log(1)

💖 NAME 💖

okay so bestie, this is mqttui-log(1) from the General Commands Manual — the page for the mqttui log command. Its job is literally: log values from subscribed topics to stdout. main character behavior, no cap. 💅

✨ SYNOPSIS ✨

mqttui log [-j|--json] [-v|--verbose] [--qos] [-b|--broker]
[-u|--username] [--password] [-i|--client-id] [--ca-cert]
[--client-cert] [--client-private-key] [--insecure] [-h|--help] [TOPIC]

🦋 DESCRIPTION 🦋

mqttui log logs values from subscribed topics to stdout. that’s the whole vibe: subscribe, stream, stdout, slay. 🫶

🌸 OPTIONS 🌸

• -j, --json — output incoming packages as newline-delimited JSON. newline-delimited JSON is the moment. ✨
• -v, --verbose — show full MQTT communication. like the whole group chat, receipts included. 👀
• --qos <LEVEL> (default: 2) — maximum Quality of Service (QoS) for subscriptions and publishing. May also be specified with the MQTTUI_QOS environment variable.
  • 0: at most once (fire and forget)
  • 1: at least once (acknowledged delivery with potential duplicates)
  • 2: exactly once (assured delivery without duplicates)

The lower Quality of Service level for publisher and subscriber is delivered from broker to subscriber. So subscribing with 0 will never receive a 1 or 2. Publishing with 2 will be received as 1 when subscribed with 1.

• -h, --help — Print help (see a summary with '-h'). yes, the short flag gives you the summary version. 🎀
• [TOPIC] (default: #) — Topics to watch. May also be specified with the MQTTUI_TOPIC environment variable. 🍓

🔌 MQTT CONNECTION 🔌

• -b, --broker <URL> (default: mqtt://localhost) — URL which represents how to connect to the MQTT broker. Examples: mqtt://localhost, mqtt://localhost:1883, mqtts://localhost, mqtts://localhost:8883, ws://localhost/path, ws://localhost:9001/path, wss://localhost/path, wss://localhost:9001/path. May also be specified with the MQTTUI_BROKER environment variable. 🔥
• -u, --username <STRING> — username to access the mqtt broker. Anonymous access when not supplied. May also be specified with the MQTTUI_USERNAME environment variable.
• --password <STRING> — password to access the mqtt broker. Consider using a connection with TLS to the broker. Otherwise the password will be transported in plaintext. Passing the password via command line is insecure as the password can be read from the history! You should pass it via environment variable. May also be specified with the MQTTUI_PASSWORD environment variable. 🚨
• -i, --client-id <STRING> — specify the client id to connect with. May also be specified with the MQTTUI_CLIENTID environment variable. 💜
• --ca-cert <FILEPATH> — path to a trusted CA certificate PEM file for verifying the broker. The CA certificate has to be a X.509 v3 certificate since rustls does not support the less secure v1 certificates. See: <https://github.com/rustls/rustls/issues/2364>. May also be specified with the MQTTUI_CA_CERTIFICATE environment variable.
• --client-cert <FILEPATH> — path to the TLS client certificate file. Used together with --client-private-key to enable TLS client authentication. The file has to be a DER-encoded X.509 certificate serialized to PEM. May also be specified with the MQTTUI_CLIENT_CERTIFICATE environment variable.
• --client-private-key <FILEPATH> — path to the TLS client private key file. Used together with --client-cert to enable TLS client authentication. The file has to be a DER-encoded ASN.1 file in PKCS#8 form serialized to PEM. May also be specified with the MQTTUI_CLIENT_PRIVATE_KEY environment variable. 🔐
• --insecure — Allow insecure TLS connections. the name is not a drill, bestie. 🙈

okay that’s the page, periodt. shoutout to the footer: source/version log, manual mqttui-log(1), and no date line was shown in this copy — no invented date, bestie. 🎀💖