Link Search Menu Expand Document Edit GitHub


The subscribe with a context subscribes the currently active context client to the given topics. By default, it doesn’t block the console like the Subscribe without a context does. To enable this behavior you can use the -s option.

client@host> subscribe

Alias: client@host> sub


OptionLong VersionExplanationDefault
-oc--outputToConsoleIf this flag is set the output will be printed to the console.false
-s--stayThe subscribe emulates the same behavior as the subscribe command in non-shell mode.
NOTE: the subscriptions will be unsubscribed afterwards.
To cancel the command press Enter.

Subscribe Options

OptionLong VersionExplanationDefault
-t--topicThe MQTT topic the client will subscribe to. 
-q--qosDefine the quality of service level. If only one QoS is specified it will be used for all topics.
You can define a specific QoS level for every topic. The corresponding QoS levels will be matched in order to the given topics.
-of--outputToFileAppend the received publish messages to a file. Creates the file if it does not exist. 
-b64--base64Whether the received publish messages will be base64 encoded.false
-J--jsonOutputPrint the received publishes in pretty JSON format.false
-T--showTopicsPrepend the specific topic name to the received publish.false
-up--userPropertyA user property of the subscribe message. 

Help Options

OptionLong VersionExplanation
-h--helpDisplay help message for command.
-V--versionDisplay version information of the cli.


Subscribe to test topic on default settings (output will be written to Logfile. See Logging):

mqtt> con -i myClient
myClient@localhost> sub -t test