安装

MQTTX CLI 支持 Windows、macOS 和 Linux,可通过以下方式安装:

已安装 v1.13.3 或更新版本的用户可运行 mqttx update,详情请参阅更新。

安装脚本

自动为当前系统和 CPU 安装匹配的版本,装在用户目录下,无需 sudo。

macOS 和 Linux:

curl -fsSL https://emqx.sh/mqttx | sh

Windows(PowerShell):

irm https://emqx.sh/mqttx.ps1 | iex

重新运行即可更新。在 Alpine Linux 上请先安装 curl(apk add curl)。

mqttx 在 macOS 和 Linux 上位于 ~/.local/bin,在 Windows 上位于 %LOCALAPPDATA%\Programs\mqttx-cli\bin(会加入 PATH)。如果找不到命令,脚本会打印需要添加的 PATH 配置。

环境变量

变量说明
MQTTX_VERSION要安装的版本,如 1.13.0,默认为最新版
MQTTX_REGION设为 cn 时从中国大陆镜像下载
MQTTX_INSTALL_DIR, MQTTX_BIN_DIR二进制文件和 mqttx 命令的安装位置
curl -fsSL https://emqx.sh/mqttx | MQTTX_VERSION=1.13.0 sh

卸载

在 macOS 和 Linux 上,删除命令和已安装的文件:

rm ~/.local/bin/mqttx
rm -rf ~/.local/share/mqttx-cli

在 Windows 上,删除 %LOCALAPPDATA%\Programs\mqttx-cli,并在“设置 > 环境变量”中从用户 PATH 中移除其 bin 文件夹。

Homebrew

macOS 上可通过 Homebrew 安装:

brew install emqx/mqttx/mqttx-cli

NPM

需要 Node.js 运行环境。

npm install mqttx-cli -g

Docker

首先,拉取镜像:

docker pull emqx/mqttx-cli

交互模式

启动容器内的交互式 Shell 会话(允许执行多条命令):

docker run -it --rm emqx/mqttx-cli

进入容器的 Shell 后,您可以运行 mqttx 命令(例如 mqttx conn、mqttx pub)。例如:

❯ docker run -it --rm emqx/mqttx-cli
/app # mqttx conn -h broker.emqx.io -p 1883
✔ Connected
- Press Ctrl+C to disconnect and exit

一次性命令执行

直接执行单个 MQTTX 命令而无需进入 Shell:

# 示例:连接 Broker
docker run --rm emqx/mqttx-cli mqttx conn -h broker.emqx.io -p 1883

# 示例:发布消息
docker run --rm emqx/mqttx-cli mqttx pub -t test -m "hello world" -h broker.emqx.io

# 示例:订阅主题
docker run --rm emqx/mqttx-cli mqttx sub -t test -h broker.emqx.io

手动下载

从 MQTTX CLI 下载页面、发布页面或更多下载下载打包好的二进制文件。请选择与您的平台和 CPU 架构匹配的文件:

平台文件
macOS Intelmqttx-cli-macos-x64
macOS Apple Siliconmqttx-cli-macos-arm64
Linux x86-64mqttx-cli-linux-x64
Linux ARM64mqttx-cli-linux-arm64
Alpine x86-64mqttx-cli-alpine-x64
Alpine ARM64mqttx-cli-alpine-arm64
Windows x64mqttx-cli-win-x64.exe
Windows ARM64mqttx-cli-win-arm64.exe

下面的示例在 macOS 或 Linux 上下载最新的已发布版本,并以当前用户身份安装,无需 sudo:

curl -fLo mqttx https://github.com/emqx/MQTTX/releases/latest/download/mqttx-cli-linux-x64
chmod +x mqttx
mkdir -p ~/.local/bin && mv mqttx ~/.local/bin/mqttx

将 mqttx-cli-linux-x64 替换为适用于您平台的文件名。如需全局安装,请运行 sudo install -m 755 mqttx /usr/local/bin/mqttx,而不是将文件移动到 ~/.local/bin。

如需安装指定版本,请在发布页面选择对应版本的文件。

Windows 用户请下载适用于对应架构的 .exe 文件,然后在终端中运行。

注意:在使用需要输入字符串数据的命令时,在 Windows cmd 中使用双引号,而在 PowerShell 中可以使用单引号。此外,路径使用的是 \,而在其他操作系统中,则使用 /。

验证安装

安装完成后,可以通过以下命令验证是否安装成功:

mqttx -v