Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

mqtt_tui

mqtt_tui is a terminal-UI MQTT client built on Yuneta’s MQTT module (C_PROT_MQTT2). It drives the session itself — one yuno = one client — and is handy for interactive broker exploration, manual subscribe/publish, MQTT v5 property inspection, and OAuth2-authenticated MQTT testing. It speaks v3.1 / v3.1.1 / v5.0.

Usage

mqtt_tui [OPTIONS]

Run mqtt_tui --help for the full list. The meaningful groups:

MQTT session

OptionShortPurpose
--id=<CLIENT_ID>-iMQTT client id
--mqtt_protocol=<p>-qmqttv5 | mqttv311 | mqttv31 (default v5)
--mqtt-persistent-session-cPersistent session (clean_session=0)
--mqtt-persistent-db-dPersist inflight/queued messages client-side
--mqtt_session_expiry_interval=<s>-xv5 session expiry (-1/ = never)
--mqtt_keepalive=<s>-aKeepalive seconds (default 60)
--mqtt_connect_properties='{…}'-ev5 CONNECT properties as JSON
--will-topic / --will-payload / --will-qos / --will-retain / --will-propertiesLast Will & Testament (v5 will properties as JSON)

Connection & auth

--url/-u, plus the same OAuth2 / OIDC flags as ycommand (--issuer/-I, --token-endpoint/-T, --client-id/-Z, …). With OIDC, mqtt_tui fetches a JWT from the realm and presents it as the MQTT password; otherwise plain MQTT username/password is used. See Authentication (OAuth2 / OIDC).

See also