At least Java 8 is required to run MQTT CLI.
The CLI is implemented with Java 11 which is the preferred version to run this project.
You can run MQTT-CLI on every OS which supports Docker. To execute a simple command use the following syntax:
docker run hivemq/mqtt-cli <your-command>
To start the Shell-Mode of the CLI you need to add the
-it flags to the docker-command:
docker run -it hivemq/mqtt-cli shell
brew install hivemq/mqtt-cli/mqtt-cli
NOTE: If you encounter an error like
Java 1.8+ is required to install this formula please install a java version higher than 1.8. You can use
brew install --cask zulu to install the latest release of Azul Zulu OpenJDK.
NOTE: As latency-issues may slow down the CLI under Mac OS X please verify that you have the entry
127.0.0.1 localhost your-pc-name specified under
/etc/hosts. You can use
sudo sh -c "echo 127.0.0.1 localhost $(hostname) >> /etc/hosts" to append this configuration to your hosts file.
Download the Windows Zipfile and extract it in your preferred location. To execute MQTT CLI simply open the Windows Command Prompt with
⊞ Win +
R and execute
cmd. Navigate into the extracted MQTT CLI folder and execute
To quick start the shell simply double-click the
If you are using a *nix operating system which operates with debian packages you can download the MQTT CLI debian package from the releases page via
curl and install the package with
sudo dpkg -i or
sudo apt install:
wget https://github.com/hivemq/mqtt-cli/releases/download/v4.19.0/mqtt-cli-4.19.0.deb sudo apt install ./mqtt-cli-4.19.0.deb
For Red Hat, Fedora, Mandriva, OpenSuse, CentOS distributions you can use the rpm package provided at releases page. The preferred way is to install the package via the
yum package manager. To install the package simply execute:
sudo yum install -y https://github.com/hivemq/mqtt-cli/releases/download/v4.19.0/mqtt-cli-4.19.0.rpm
- mqtt-cli uses Gradle to build.
- To be able to execute integration tests a running Docker environment is required
- To be able to build and test the native image a GraalVM installation is required. You can set it up with
To do a clean build, issue the following command:
./gradlew clean build
This runs the unit tests and compiles a new mqtt-cli-
build.gradle.kts file contains further instructions for building the platform specific distribution packages. In a nutshell:
For MacOS/Linux brew:
For the Debian package:
For the RPM package:
For the Windows installer:
For building a local docker image: