# MQTTX
**Repository Path**: WqlPersionalRepository/MQTTX
## Basic Information
- **Project Name**: MQTTX
- **Description**: MQTT X 是 EMQ 开源的一款跨平台 MQTT 5.0 客户端工具，它支持 macOS, Linux, Windows，并且支持 MQTT 消息格式转换。
- **Primary Language**: TypeScript
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: https://mqttx.app/zh
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 40
- **Created**: 2022-06-25
- **Last Updated**: 2022-06-25
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
[](https://github.com/emqx/mqttx/releases)
[](https://github.com/emqx/mqttx/releases)
[](https://slack-invite.emqx.io/) [](https://discord.gg/xYGf3fQnES)
[](https://github.com/emqx/MQTTX/discussions)
[](https://www.youtube.com/channel/UC5FjR77ErAxvZENEWzQaO5Q)
[](https://twitter.com/EMQTech)
English | [简体中文](./README-CN.md) | [日本語](./README-JP.md)
---
[MQTT X](https://mqttx.app) is a cross-platform MQTT 5.0 client tool open sourced by [EMQ](https://www.emqx.com/en), which can run on macOS, Linux and Windows, and supports formatting MQTT payload.
[MQTT X](https://mqttx.app) simplifies the operation logic of the page with the help of chatting software, makes it easy and quick to create multiple simultaneous online MQTT client connections, test the connection, publish, and subscribe functions of MQTT/TCP, MQTT/TLS, MQTT/WebSocket as well as other MQTT protocol features.
> [MQTT](http://mqtt.org/faq) 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
[](https://apps.apple.com/us/app/mqttx/id1514074565?mt=12)
### Homebrew
The macOS users can install MQTT X using [brew cask](https://formulae.brew.sh/cask/mqttx)
```shell
brew install --cask mqttx
```
### Linux
[](https://snapcraft.io/mqttx)
### Released Packages
Download from [GitHub Releases](https://github.com/emqx/MQTTX/releases) and install it.
Alternative, you can download [here](https://www.emqx.io/downloads/MQTTX/).
## Usage
See our [blog](https://www.emqx.io/blog/mqtt-x-guideline) or [manual](./docs/manual.md) 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](https://www.emqx.com/en/cloud) for testing:
```shell
Broker IP: broker.emqx.io
Broker TCP Port: 1883
Broker SSL Port: 8883
```
- To run MQTT Broker locally, [EMQX](https://www.emqx.com/en/products/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
MQTT X 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](https://www.emqx.com/en/try?product=cloud)
[Download EMQX locally right now](https://www.emqx.com/en/try?product=enterprise)
## Community
The MQTT X community can be found on [GitHub Discussions](https://github.com/emqx/MQTTX/discussions), where you can ask questions, voice ideas, and share your projects.
To chat with other community members you can join the [EMQX Slack](https://slack-invite.emqx.io) or [Discord](https://discord.gg/xYGf3fQnES).
## Develop
Recommended version for Node environment:
- v14.\*.\*
``` shell
# Clone
git clone git@github.com: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:
```shell
# 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](https://github.com/emqx/MQTTX/blob/master/.github/CONTRIBUTING.md) before making a pull request.
## Technology Stack
- [Electron](https://electronjs.org/)
- [Vue](https://vuejs.org/) + [Element](https://element.eleme.io)
- [TypeScript](https://www.typescriptlang.org/)
- [TypeORM](https://github.com/typeorm/typeorm)
- [SQLite](https://github.com/mapbox/node-sqlite3)
- [MQTT.js](https://github.com/mqttjs/MQTT.js)
## License
Apache License 2.0, see [LICENSE](https://github.com/emqx/MQTTX/blob/master/LICENSE).