# MQTTX CLI [](https://github.com/emqx/mqttx/releases)   [](https://mqttx.app/downloads) [](https://hub.docker.com/r/emqx/mqttx-web) [](https://hub.docker.com/r/emqx/mqttx-cli) [](https://github.com/emqx/MQTTX/discussions) [](https://slack-invite.emqx.io/) [](https://discord.gg/xYGf3fQnES) [](https://www.youtube.com/channel/UC5FjR77ErAxvZENEWzQaO5Q) [](https://twitter.com/EMQTech) --- [MQTTX CLI](https://mqttx.app/cli) is an open source MQTT 5.0 CLI Client and MQTTX on the command line. Designed to help develop and debug MQTT services and applications faster without the need to use a graphical interface. > [MQTT](https://www.emqx.com/en/blog/the-easiest-guide-to-getting-started-with-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  ## Documentation Explore the full range of features and learn how to get the most out of MQTTX CLI with our comprehensive [MQTTX CLI Documentation](https://mqttx.app/docs/cli). ## Installation Get started by downloading MQTTX CLI from the [MQTTX Downloads Page](https://mqttx.app/downloads). Installation instructions are provided for different platforms to ensure a smooth setup. ## Quickstart Once you've installed MQTTX CLI, you can immediately begin exploring its capabilities. Start with these basic commands: - **Connect to a Broker** ```shell mqttx conn -h 'broker.emqx.io' -p 1883 -u 'admin' -P 'public' ``` - **Subscribe to a Topic** ```shell mqttx sub -t 'hello' -h 'broker.emqx.io' -p 1883 ``` - **Publish a Message** ```shell mqttx pub -t 'hello' -h 'broker.emqx.io' -p 1883 -m 'from MQTTX CLI' ``` For additional information on usage and advanced features, please consult our [Getting Started Guide](https://mqttx.app/docs/cli/get-started). ## 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](https://www.emqx.com/en/try?product=cloud) [Download EMQX locally right now](https://www.emqx.com/en/try?product=enterprise) ## Get Involved - Follow [@EMQTech on Twitter](https://twitter.com/EMQTech). - If you have a specific question, check out our [discussion forums](https://github.com/emqx/emqx/discussions). - For general discussions, join us on the [official Discord](https://discord.gg/xYGf3fQnES) team. - Keep updated on [EMQX YouTube](https://www.youtube.com/channel/UC5FjR77ErAxvZENEWzQaO5Q) by subscribing. ## Develop Recommended version for Node environment: - v18.\*.\* ``` shell # Clone git clone git@github.com:emqx/MQTTX.git # Install dependencies cd MQTTX/cli yarn install # Compiles and hot-reloads for development yarn run dev # Compiles and minifies for production yarn run build ``` After a successful build, the corresponding file for the successful build will appear in the `dist` directory and will need to be used in a Node.js environment. If you need to package a binary executable, please refer to the following command. ```shell # Install pkg lib npm install pkg -g # Build binary pkg package.json ``` After a successful build, you will see the binary executable for each system in the `release` directory. ## Contributing Please make sure to read the [Contributing Guide](https://github.com/emqx/MQTTX/blob/main/.github/CONTRIBUTING.md) before making a pull request. ## Technology Stack - [TypeScript](https://www.typescriptlang.org/) - [Node.js](https://nodejs.org/en/) - [pkg](https://github.com/vercel/pkg) - [MQTT.js](https://github.com/mqttjs/MQTT.js) ## License Apache License 2.0, see [LICENSE](https://github.com/emqx/MQTTX/blob/main/LICENSE).