emqx/mqttx

---

MQTTX is a cross-platform MQTT 5.0 client tool open sourced by EMQ, which can run on macOS, Linux and Windows, and supports formatting MQTT payload.

MQTTX simplifies test operation with the help of a familiar, chat-like interface. It’s easy and quick to create multiple, simultaneous online MQTT client connections, and can test the connection, publishing, and subscription functions of MQTT/TCP, MQTT/TLS, MQTT/WebSocket as well as other MQTT protocol features.

MQTT stands for MQ Telemetry Transport. It is a publish/subscribe, extremely simple and lightweight messaging protocol, designed for constrained devices and low-bandwidth, high-latency or unreliable networks.

Preview

Installation

Currently available for download from these app stores

macOS App Store

Homebrew

The macOS users can install MQTTX using brew cask

brew install --cask mqttx

Linux

Released Packages

Download from GitHub Releases and install it.

Alternative, you can download here.

AI Agent Support

Install or update MQTTX CLI

INSTALL.md provides installation and update instructions for agents, including environment detection, package selection, and version verification. Give your agent this prompt:

Read https://raw.githubusercontent.com/emqx/MQTTX/main/INSTALL.md and follow its instructions to install or update MQTTX CLI for this environment. Verify the executable path and version.

Use the MQTTX CLI skill

The mqttx-cli skill helps agents use MQTTX CLI for connection checks, messaging, MQTT 5 features, TLS/authentication, payload codecs, benchmarks, data simulation, and troubleshooting.

Install it with the Skills CLI:

npx skills add emqx/MQTTX --skill mqttx-cli

To install from a local checkout, run npx skills add . --skill mqttx-cli from the repository root. You can also copy the entire skills/mqttx-cli directory (including references) into your agent’s supported skills directory, or ask the agent to read its SKILL.md directly.

Once installed, try a task such as:

Use the mqttx-cli skill to verify a publish/subscribe round trip against my local broker at 127.0.0.1:1883. Use a unique topic under mqttx-test/, finish within 15 seconds, and report the result.

Usage

See our documentation or manual for details.

1. Get MQTT Broker Ready.

   • If you do not need to deploy the MQTT Broker locally, you can use the public MQTT 5.0 Broker provided by EMQX Cloud for testing:

     Broker IP: broker.emqx.io
     Broker TCP Port: 1883
     Broker SSL Port: 8883
     

   • To run MQTT Broker locally, EMQX is recommended: An Open-Source, Cloud-Native, Distributed MQTT Broker for IoT.

2. Connection configuration. Click the + button in the left menu bar and fill in the corresponding required fields in the form.

3. After the connection information is configured, click the Connect button in the upper right corner to create a connection and connect to MQTT Broker.

4. After the MQTT is connected successfully, you can perform MQTT publish and subscription tests.

Better Together with EMQX

MQTTX is designed to connect to test MQTT Brokers such as EMQX, The one-click connection and simple graphical interface make it easy to connect to EMQX or EMQX Cloud to debug and explore functional features.

Sign up EMQX Cloud for 14 days free trial

Download EMQX locally right now

Get Involved

• Follow @EMQTech on Twitter.
• If you have a specific question, check out our discussion forums.
• For general discussions, join us on the official Discord team.
• Keep updated on EMQX YouTube by subscribing.

Develop

Recommended version for Node environment:

• v18.*.*

# Clone
git clone [email protected]:emqx/MQTTX.git

# Install dependencies
cd MQTTX
yarn install

# Compiles and hot-reloads for development
yarn run electron:serve

# Compiles and minifies for production
yarn run electron:build

After the building is successful, the corresponding installation file for the successful build ing will appear in the dist_electron directory.

If you need to package it as an installation package for an independent operating system, please refer to the following command:

# For Windows
yarn run electron:build-win

# For Linux
yarn run electron:build-linux

# For macOS
yarn run electron:build-mac

Contributing

Please make sure to read the Contributing Guide before making a pull request.

Technology Stack

• Electron
• Vue + Element
• TypeScript
• TypeORM
• SQLite
• MQTT.js

Resources

• MQTT Programming

  A series of blogs to help developers get started quickly with MQTT in PHP, Node.js, Python, Golang, and other programming languages.

• MQTT SDKs

  We have selected popular MQTT client SDKs in various programming languages and provided code examples to help you quickly understand the use of MQTT clients.

License

Apache License 2.0, see LICENSE.