mqttui(1)                   General Commands Manual                  mqttui(1)

NAME
       mqttui - Subscribe to a MQTT Topic or publish something quickly from
       the terminal

SYNOPSIS
       mqttui [--qos] [--payload-size-limit] [-b|--broker] [-u|--username]
       [--password] [-i|--client-id] [--ca-cert] [--client-cert]
       [--client-private-key] [--insecure] [-h|--help] [-V|--version] [TOPIC]
       [subcommands]

DESCRIPTION
       Subscribe to a MQTT Topic or publish something quickly from the
       terminal

OPTIONS
       --qos <LEVEL> [default: 2]
              Maximum Quality of Service (`QoS`) for subscriptions and
              publishing.

              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.

              - 0: at most once (fire and forget)

              - 1: at least once (acknowledged delivery with potential
              duplicates)

              - 2: exactly once (assured delivery without duplicates)
              May also be specified with the MQTTUI_QOS environment variable.

       --payload-size-limit <PAYLOAD_SIZE_LIMIT> [default: 8000]
              Truncate the payloads stored to the given size.

              Payloads bigger than that are truncated and not inspected for
              formats like JSON or MessagePack. Only their beginning up to the
              specified amount of bytes can be viewed. Increasing this value
              might result in higher memory consumption especially over time.
              May also be specified with the MQTTUI_PAYLOAD_SIZE_LIMIT
              environment variable.

       -h, --help
              Print help (see a summary with '-h')

       -V, --version
              Print version

       [TOPIC] [default: #]
              Topic 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

SUBCOMMANDS
       mqttui-clean-retained(1)
              Clean retained messages from the broker

       mqttui-log(1)
              Log values from subscribed topics to stdout

       mqttui-read-one(1)
              Wait for the first message on the given topic(s) and return its
              payload to stdout

       mqttui-publish(1)
              Publish a value quickly

VERSION
       v0.24.0

                                 mqttui 0.24.0                       mqttui(1)