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> sub    -t <topics> [-t <topics>]... 
                    [-q <qos>]... 
                    [-of <receivedMessagesFile>]
                    [-up <userProperties>]... 


OptionLong VersionExplanationDefault
-t--topicThe MQTT topic the client will subscribe to. 
-q--qosUse a defined quality of service level on all topics if only one QoS is specified. You can define a specific QoS level for every topic. The corresponding QoS levels will be matched in order to the given topics.0
-oc--outputToConsoleIf this flag is set the output will be printed to the console.false
-of--outputToFileIf a file is given print the received publishes to the specified output file. If the file is not present it will be created. 
-b64--base64If set 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. 
-s The subscribe emulates the same behavior as the subscribe command in non-shell mode.
Note: the subscriptions will be unsubscribed afterwards.
To cancel the command simply press Enter.


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

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