NAME

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

SYNOPSIS

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

DESCRIPTION

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

OPTIONS

--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.

-h, --help

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

-V, --version

Print version

[TOPIC] [default: #]

Topic to watch

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`

-u, --username=STRING

Username to access the mqtt broker.

Anonymous access when not supplied.

--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.

-i, --client-id=STRING

Specify the client id to connect with

--client-cert=FILEPATH

Path to the TLS client certificate file.

Used together with --client-key to enable TLS client authentication. The file has to be a DER-encoded X.509 certificate serialized to PEM.

--client-key=FILEPATH

Path to the TLS client private key.

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.

--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.22.1