.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.TH mqttui 1  "mqttui 0.24.0" 
.SH NAME
mqttui \- Subscribe to a MQTT Topic or publish something quickly from the terminal
.SH SYNOPSIS
\fBmqttui\fR [\fB\-\-qos\fR] [\fB\-\-payload\-size\-limit\fR] [\fB\-b\fR|\fB\-\-broker\fR] [\fB\-u\fR|\fB\-\-username\fR] [\fB\-\-password\fR] [\fB\-i\fR|\fB\-\-client\-id\fR] [\fB\-\-ca\-cert\fR] [\fB\-\-client\-cert\fR] [\fB\-\-client\-private\-key\fR] [\fB\-\-insecure\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] [\fITOPIC\fR] [\fIsubcommands\fR]
.SH DESCRIPTION
Subscribe to a MQTT Topic or publish something quickly from the terminal
.SH OPTIONS
.TP
\fB\-\-qos\fR \fI<LEVEL>\fR [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)
.RS
May also be specified with the \fBMQTTUI_QOS\fR environment variable. 
.RE
.TP
\fB\-\-payload\-size\-limit\fR \fI<PAYLOAD_SIZE_LIMIT>\fR [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.
.RS
May also be specified with the \fBMQTTUI_PAYLOAD_SIZE_LIMIT\fR environment variable. 
.RE
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help (see a summary with \*(Aq\-h\*(Aq)
.TP
\fB\-V\fR, \fB\-\-version\fR
Print version
.TP
[\fITOPIC\fR] [default: #]
Topic to watch
.RS
May also be specified with the \fBMQTTUI_TOPIC\fR environment variable. 
.RE
.SH "MQTT CONNECTION"
.TP
\fB\-b\fR, \fB\-\-broker\fR \fI<URL>\fR [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`
.RS
May also be specified with the \fBMQTTUI_BROKER\fR environment variable. 
.RE
.TP
\fB\-u\fR, \fB\-\-username\fR \fI<STRING>\fR
Username to access the mqtt broker.

Anonymous access when not supplied.
.RS
May also be specified with the \fBMQTTUI_USERNAME\fR environment variable. 
.RE
.TP
\fB\-\-password\fR \fI<STRING>\fR
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.
.RS
May also be specified with the \fBMQTTUI_PASSWORD\fR environment variable. 
.RE
.TP
\fB\-i\fR, \fB\-\-client\-id\fR \fI<STRING>\fR
Specify the client id to connect with
.RS
May also be specified with the \fBMQTTUI_CLIENTID\fR environment variable. 
.RE
.TP
\fB\-\-ca\-cert\fR \fI<FILEPATH>\fR
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>
.RS
May also be specified with the \fBMQTTUI_CA_CERTIFICATE\fR environment variable. 
.RE
.TP
\fB\-\-client\-cert\fR \fI<FILEPATH>\fR
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.
.RS
May also be specified with the \fBMQTTUI_CLIENT_CERTIFICATE\fR environment variable. 
.RE
.TP
\fB\-\-client\-private\-key\fR \fI<FILEPATH>\fR
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.
.RS
May also be specified with the \fBMQTTUI_CLIENT_PRIVATE_KEY\fR environment variable. 
.RE
.TP
\fB\-\-insecure\fR
Allow insecure TLS connections
.SH SUBCOMMANDS
.TP
mqttui\-clean\-retained(1)
Clean retained messages from the broker
.TP
mqttui\-log(1)
Log values from subscribed topics to stdout
.TP
mqttui\-read\-one(1)
Wait for the first message on the given topic(s) and return its payload to stdout
.TP
mqttui\-publish(1)
Publish a value quickly
.SH VERSION
v0.24.0