Publish

Publishes a message to one or more topics.

Simple Examples

Command	Explanation
`mqtt pub -t test -m "Hello"`	Publish the message `Hello` with topic ‘topic’ using the default settings
`mqtt pub -t test1 -t test2 -m "Hello Tests"`	Publish the message `Hello Tests` with topics ‘test1’ and ‘test2’
`mqtt pub -t test -m "Hello" -h localhost -p 1884`	Publish the message `Hello` with topic ‘topic’ to a broker at localhost:1884
`mqtt pub -t test -m:file payload.txt`	Publish the message in payload.txt with topic ‘topic’ using the default settings

Synopsis

mqtt pub    -t <topics> [-t <topics>]... 
            (-m <message> | -m:file <filename>)
            [-cdrsvl] 
            [-q <qos>]...
            [-e <messageExpiryInterval>]          
            [-ct <contentType>] 
            [-cd <correlationData>] 
            [-pf <payloadFormatIndicator>] 
            [-rt <responseTopic>] 
            [-up <userProperties>]...                   
            [-h <host>]    
            [-p <port>] 
            [-V <version>]
            [-i <identifier>] 
            [-ip <identifierPrefix>] 
            [-k <keepAlive>] 
            [-se <sessionExpiryInterval>]
            [-Cup <connectUserProperties>]... 
            [-ws]
            [-ws:path <webSocketPath>]
            [-u <user>] 
            [-pw [<password>]] 
            [-pw:env [<environmentVariable>]]
            [-pw:file FILE]
            [--cert <clientCertificate>] 
            [--key <clientPrivateKey>] 
            [--cafile FILE]... 
            [--capath DIR]... 
            [--ciphers <cipherSuites>[: <cipherSuites>...]]...
            [--tls-version <supportedTLSVersions>]...
            [-Wd <willDelayInterval>]                                                                          
            [-We <willMessageExpiryInterval>]                 
            [-Wm <willMessage>] 
            [-Wq <willQos>] 
            [-Wr]
            [-Wt <willTopic>] 
            [-Wcd <willCorrelationData>]
            [-Wct <willContentType>]                        
            [-Wpf <willPayloadFormatIndicator>]
            [-Wrt <willResponseTopic>]
            [-Wup <willUserProperties>]...  
            [--rcvMax <receiveMaximum>] 
            [--sendMax <sendMaximum>] 
            [--maxPacketSize <maximumPacketSize>]                                             
            [--sendMaxPacketSize <sendMaximumPacketSize>]
            [--topicAliasMax <topicAliasMaximum>]       
            [--sendTopicAliasMax <sendTopicAliasMaximum>] 
            [--[no-]reqProblemInfo] 
            [--[no-]reqResponseInfo]  
            [--help] 
            [--version]         

Publish options

Option	Long Version	Explanation	Default
`-t`	`--topic`	The MQTT topic to which the message will be published.
`-m`	`--message`	The message which will be published on the topic.
`-m:file`	`--message-file`	The file whose payload will be published on the topic.
`-r`	`--[no-]retain`	Whether the message will be retained.	`False`
`-q`	`--qos`	Define 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.	`0`
`-e`	`--messageExpiryInterval`	The lifetime of the publish message in seconds.
`-ct`	`--contentType`	A description of the content of the publish message.
`-cd`	`--correlationData`	The correlation data of the publish message.
`-pf`	`--payloadFormatIndicator`	The payload format indicator of the publish message.
`-rt`	`--responseTopic`	The topic name for the response message of the publish message.
`-up`	`--userProperty`	A user property of the publish message
`-d`	`--debug`	Print debug level messages to the console.	`False`
`-v`	`--verbose`	Print trace level messages to the console.	`False`
`-l`		Log to ~./mqtt.cli/logs (Configurable through ~/.mqtt-cli/config.properties)	`false`

Connect Options

Option	Long Version	Explanation	Default
`-h`	`--host`	The MQTT host.	`localhost`
`-p`	`--port`	The MQTT port.	`1883`
`-V`	`--mqttVersion`	The MQTT version can be set to 3 or 5.	`5`
`-i`	`--identifier`	A unique client identifier can be defined.	A randomly generated UTF-8 String.
`-ip`	`--identifierPrefix`	The prefix for randomly generated client identifiers, if no identifier is given.	`mqttClient`
`-c`	`--[no-]cleanStart`	Whether the client should start a clean session.	`True`
`k`	`--keepAlive`	The keep alive of the client (in seconds)	`60`
`-se`	`--sessionExpiryInterval`	Session expiry value in seconds.	`0` (Instant Expiry)
`-Cup`	`--connectUserProperty`	A user property of the connect message.
`--ws`		Use WebSocket transport protocol.	`False`
`--ws:path`		The path to the WebSocket located at given broker host.

Security Options

Option	Long Version	Explanation	Default
`-s`	`--secure`	Whether a default SSL configuration is used.	`False`
`-u`	`--user`	Define the username for authentication.
`-pw`	`--password`	Define the password for authentication directly. If left blank the user will be prompted for the password in console.
`-pw:env`		Define that the password for authentication is read in from an environment variable.	`MQTT_CLI_PW` if option is specified without value
`-pw:file`		Define the path to a file from which the password is read in.
	`--cert`	The path to the client certificate to use for client-side authentication.
	`--key`	The path to the corresponding private key for the given client certificate.
	`--cafile`	The path to the file containing a trusted CA certificate to enable encrypted certificate based communication.
	`--capath`	The path to the directory containing trusted CA certificates to enable encrypted certificate based communication.
	`--ciphers`	The supported cipher suites in IANA string format concatenated by the ‘:’ character if more than one cipher should be supported. e.g `TLS_CIPHER_1:TLS_CIPHER_2` See IANA Format for supported cipher suite strings.
	`--tls-version`	The TLS version to use - `TLSv1.1` `TLSv1.2` `TLSv1.3`	`TLSv1.2`

Will Options

Option	Long Version	Explanation	Default
`-Wd`	`--willDelayInterval`	Will delay interval in seconds.	`0`
`-We`	`--willMessageExpiryInterval`	Lifetime of the will message in seconds. Can be disabled by setting it to `4_294_967_295`	`4_294_967_295` (Disabled)
`-Wm`	`--willPayload`	Payload of the will message.
`-Wq`	`--willQualityOfService`	QoS level of the will message.	`0`
`-Wr`	`--[no-]willRetain`	Retain the will message.	`False`
`-Wt`	`--willTopic`	Topic of the will message.
`-Wcd`	`--willCorrelationData`	Correlation data of the will message
`-Wct`	`--willContentType`	Description of the will message’s content.
`-Wpf`	`--willPayloadFormatIndicator`	Payload format can be explicitly specified as `UTF8` else it may be `UNSPECIFIED`.
`-Wrt`	`--willResponseTopic`	Topic Name for a response message.
`-Wup`	`--willUserProperties`	A user property of the will message.

Connect Restrictions

Long Version	Explanation	Default
`--rcvMax`	The maximum amount of not acknowledged publishes with QoS 1 or 2 the client accepts from the server concurrently.	`65535`
`--sendMax`	The maximum amount of not acknowledged publishes with QoS 1 or 2 the client send to the server concurrently.	`65535`
`--maxPacketSize`	The maximum packet size the client accepts from the server.	`268435460`
`--sendMaxPacketSize`	The maximum packet size the client sends to the server.	`268435460`
`--topicAliasMax`	The maximum amount of topic aliases the client accepts from the server.	`0`
`--sendTopicAliasMax`	The maximum amount of topic aliases the client sends to the server.	`16`
`--[no-]reqProblemInfo`	The client requests problem information from the server.	`true`
`--[no-]reqResponseInfo`	The client requests response information from the server.	`false`

Further Examples

Publish a message with default QoS set to Exactly Once

NOTE: If you specify one QoS and multiple topics, the QoS will be used for all topics.

$ mqtt pub -t topic1 -t topic2 -q 2

Publish a message with a specific QoS for each topic. ('topic1' will have QoS 0, 'topic2' QoS 1 and 'topic3' QoS 2)

$ mqtt pub -t topic1 -q 0 -t topic2 -q 1 -t topic3 -q 2

Publish

Simple Examples

Synopsis

Publish options

Connect Options

Security Options

Will Options

Connect Restrictions

Further Examples

Table of contents