mqttui-clean-retained(1)

NAME
mqttui-clean-retained - Clean retained messages from the broker

SYNOPSIS
mqttui clean-retained [--timeout] [--dry-run] [-b|--broker] [-u|--username] [--password] [-i|--client-id] [--client-cert] [--client-key] [--insecure] [-h|--help] <TOPIC>

DESCRIPTION
Clean retained messages from the broker.

This works by subscribing to the topic and waiting for messages with the retained flag. Then a message with an empty payload is published retained which clears the topic on the broker. Ends on the first non retained message or when the timeout is reached.

OPTIONS

--timeout=SECONDS [default: 5]
    When there is no message received for the given time the operation is considered done

--dry-run
    Dont clean topics, only log them

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

<TOPIC>
    Topic which gets cleaned. Supports filters like 'foo/bar/#'.

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.

--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.
    May also be specified with the MQTTUI_CLIENT_CERTIFICATE environment variable.

--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.
    May also be specified with the MQTTUI_CLIENT_PRIVATE_KEY environment variable.

--insecure
    Allow insecure TLS connections