Skip to content

Commit

Permalink
docs(readme): add connect command for CLI readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@Red-Asuka @ysfscream
Red-Asuka authored and ysfscream committed Jul 21, 2022
1 parent 1128498 commit 9f5b812
Show file tree
Hide file tree
Showing 2 changed files with 186 additions and 107 deletions.
152 changes: 96 additions & 56 deletions cli/README-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
[![YouTube](https://img.shields.io/badge/Subscribe-EMQ%20中文-FF0000?logo=youtube)](https://www.youtube.com/channel/UCir_r04HIsLjf2qqyZ4A8Cg)
[![Twitter](https://img.shields.io/badge/Follow-EMQ-1DA1F2?logo=twitter)](https://twitter.com/EMQTech)

[English](./README.md) | 简体中文
[English](https://github.com/emqx/MQTTX/blob/main/cli/README.md) | 简体中文

---

Expand All @@ -34,14 +34,14 @@
#### Intel Chip

```shell
curl -LO https://www.emqx.com/zh/downloads/MQTTX/v1.8.0/mqttx-cli-macos-x64
curl -LO https://www.emqx.com/zh/downloads/MQTTX/v1.8.0/mqttx-cli-macos-x64
sudo install ./mqttx-cli-macos-x64 /usr/local/bin/mqttx
```

#### Apple Silicon

```shell
curl -LO https://www.emqx.com/zh/downloads/MQTTX/v1.8.0/mqttx-cli-macos-arm64
curl -LO https://www.emqx.com/zh/downloads/MQTTX/v1.8.0/mqttx-cli-macos-arm64
sudo install ./mqttx-cli-macos-arm64 /usr/local/bin/mqttx
```

Expand All @@ -60,14 +60,14 @@ brew install emqx/mqttx/mqttx-cli
#### x86-64

```shell
curl -LO https://www.emqx.com/zh/downloads/MQTTX/v1.8.0/mqttx-cli-linux-x64
curl -LO https://www.emqx.com/zh/downloads/MQTTX/v1.8.0/mqttx-cli-linux-x64
sudo install ./mqttx-cli-linux-x64 /usr/local/bin/mqttx
```

#### ARM64

```shell
curl -LO https://www.emqx.com/zh/downloads/MQTTX/v1.8.0/mqttx-cli-linux-arm64
curl -LO https://www.emqx.com/zh/downloads/MQTTX/v1.8.0/mqttx-cli-linux-arm64
sudo install ./mqttx-cli-linux-arm64 /usr/local/bin/mqttx
```

Expand All @@ -91,6 +91,12 @@ npm install mqttx-cli -g

### 快速使用

Connect

```shell
mqttx conn -h 'broker.emqx.io' -p 1883 -u 'admin' -P 'public'
```

Subscribe

```shell
Expand All @@ -114,69 +120,103 @@ mqttx --help
| -v, --version | 输出当前 MQTT X CLI 的版本号 |
| -h, --help | 展示 mqttx 命令的帮助信息 |

| 命令 | 描述 |
| ---- | ------------------ |
| pub | 向主题发布一条消息 |
| sub | 订阅一个主题 |
| 命令 | 描述 |
| ---- | -------------------------------- |
| conn | 创建一个连接并连接到 MQTT Broker |
| pub | 向主题发布一条消息 |
| sub | 订阅一个主题 |

#### 连接

```shell
mqttx conn --help
```

| 参数 | 描述 |
| ------------------------------------------ | ---------------------------------------------- |
| -V, --mqtt-version <5/3.1.1/3.1> | MQTT 版本，默认为 5 |
| -h, --hostname <HOST> | MQTT Broker 的 Host 地址，默认为 localhost |
| -p, --port <PORT> | MQTT Broker 的端口号 |
| -i, --client-id <ID> | 客户端 ID |
| --clean | clean session 的标志位，默认为 true |
| -k, --keepalive <SEC> | MQTT 的 Keep Alive，默认为 30 |
| -u, --username <USER> | 连接到 MQTT Broker 的用户名 |
| -P, --password <PASS> | 连接到 MQTT Broker 的密码 |
| -l, --protocol <PROTO> | 连接时的协议，mqtt, mqtts, ws or wss |
| --key <PATH> | key 文件的路径 |
| --cert <PATH> | cert 文件的路径 |
| --ca | ca 证书的文件路径 |
| --insecure | 取消服务器的证书校验 |
| -up, --user-properties <USERPROPERTIES...> | MQTT 5.0 用户属性，例如：-up "name: mqttx cli" |
| --will-topic <TOPIC> | 遗嘱消息的 topic |
| --will-message <BODY> | 遗嘱消息的 payload |
| --will-qos <0/1/2> | 遗嘱消息的 QoS |
| --will-retain | 遗嘱消息的 retain 标志位 |
| --help | 展示 conn 命令的帮助信息 |


#### 订阅

```shell
mqttx sub --help
```

| 参数 | 描述 |
| ---------------------- | ---------------------------------------- |
| -h, --hostname <HOST> | MQTT Broker 的 Host 地址，默为 localhost |
| -p, --port <PORT> | MQTT Broker 的端口号 |
| -i, --client-id <ID> | 客户端 ID |
| -q, --qos <0/1/2> | 消息的 QoS，默认为 0 |
| --clean | clean session 的标志位，默认为 true |
| -t, --topic <TOPIC> | 需要订阅的 Topic |
| -k, --keepalive <SEC> | MQTT 的 Keep Alive，默认为 30 |
| -u, --username <USER> | 连接到 MQTT Broker 的用户名 |
| -P, --password <PASS> | 连接到 MQTT Broker 的密码 |
| -l, --protocol <PROTO> | 连接时的协议，mqtt, mqtts, ws or wss |
| --key <PATH> | key 文件的路径 |
| --cert <PATH> | cert 文件的路径 |
| --ca | ca 证书的文件路径 |
| --insecure | 取消服务器的证书校验 |
| --will-topic <TOPIC> | 遗嘱消息的 topic |
| --will-message <BODY> | 遗嘱消息的 payload |
| --will-qos <0/1/2> | 遗嘱消息的 QoS |
| --will-retain | 遗嘱消息的 retain 标志位 |
| -v, --verbose | 在接收到的 Payload 前显示当前 Topic |
| --help | 展示 sub 命令的帮助信息 |
| 参数 | 描述 |
| ------------------------------------------ | ---------------------------------------------- |
| -V, --mqtt-version <5/3.1.1/3.1> | MQTT 版本，默认为 5 |
| -h, --hostname <HOST> | MQTT Broker 的 Host 地址，默认为 localhost |
| -p, --port <PORT> | MQTT Broker 的端口号 |
| -i, --client-id <ID> | 客户端 ID |
| -q, --qos <0/1/2> | 消息的 QoS，默认为 0 |
| --clean | clean session 的标志位，默认为 true |
| -t, --topic <TOPIC> | 需要订阅的 Topic |
| -k, --keepalive <SEC> | MQTT 的 Keep Alive，默认为 30 |
| -u, --username <USER> | 连接到 MQTT Broker 的用户名 |
| -P, --password <PASS> | 连接到 MQTT Broker 的密码 |
| -l, --protocol <PROTO> | 连接时的协议，mqtt, mqtts, ws or wss |
| --key <PATH> | key 文件的路径 |
| --cert <PATH> | cert 文件的路径 |
| --ca | ca 证书的文件路径 |
| --insecure | 取消服务器的证书校验 |
| -up, --user-properties <USERPROPERTIES...> | MQTT 5.0 用户属性，例如：-up "name: mqttx cli" |
| --will-topic <TOPIC> | 遗嘱消息的 topic |
| --will-message <BODY> | 遗嘱消息的 payload |
| --will-qos <0/1/2> | 遗嘱消息的 QoS |
| --will-retain | 遗嘱消息的 retain 标志位 |
| -v, --verbose | 在接收到的 Payload 前显示当前 Topic |
| --help | 展示 sub 命令的帮助信息 |

#### 发布

```shell
mqttx pub --help
```

| 参数 | 描述 |
| ---------------------- | ---------------------------------------- |
| -h, --hostname <HOST> | MQTT Broker 的 Host 地址，默为 localhost |
| -p, --port <PORT> | MQTT Broker 的端口号 |
| -i, --client-id <ID> | 客户端 ID |
| -q, --qos <0/1/2> | 消息的 QoS，默认为 0 |
| -t, --topic <TOPIC> | 需要发布的 Topic |
| -m, --message<MSG> | 需要发布的 Payload 消息 |
| -r, --retain | 设置发送消息为 Retain 消息，默认为 fasle |
| -s, --stdin | 从 stdin 中读取信息体 |
| -M, --multiline | 可以通过多行发布多条消息 |
| -u, --username <USER> | 连接到 MQTT Broker 的用户名 |
| -P, --password <PASS> | 连接到 MQTT Broker 的密码 |
| -l, --protocol <PROTO> | 连接时的协议，mqtt, mqtts, ws or wss |
| --key <PATH> | key 文件的路径 |
| --cert <PATH> | cert 文件的路径 |
| --ca | ca 证书的文件路径 |
| --insecure | 取消服务器的证书校验 |
| --will-topic <TOPIC> | 遗嘱消息的 topic |
| --will-message <BODY> | 遗嘱消息的 payload |
| --will-qos <0/1/2> | 遗嘱消息的 QoS |
| --will-retain | 遗嘱消息的 retain 标志位 |
| --help | 展示 pub 命令的帮助信息 |
| 参数 | 描述 |
| ------------------------------------------ | ---------------------------------------------- |
| -V, --mqtt-version <5/3.1.1/3.1> | MQTT 版本，默认为 5 |
| -h, --hostname <HOST> | MQTT Broker 的 Host 地址，默认为 localhost |
| -p, --port <PORT> | MQTT Broker 的端口号 |
| -i, --client-id <ID> | 客户端 ID |
| -q, --qos <0/1/2> | 消息的 QoS，默认为 0 |
| -t, --topic <TOPIC> | 需要发布的 Topic |
| -m, --message<MSG> | 需要发布的 Payload 消息 |
| -r, --retain | 设置发送消息为 Retain 消息，默认为 fasle |
| -s, --stdin | 从 stdin 中读取信息体 |
| -M, --multiline | 可以通过多行发布多条消息 |
| -u, --username <USER> | 连接到 MQTT Broker 的用户名 |
| -P, --password <PASS> | 连接到 MQTT Broker 的密码 |
| -l, --protocol <PROTO> | 连接时的协议，mqtt, mqtts, ws or wss |
| --key <PATH> | key 文件的路径 |
| --cert <PATH> | cert 文件的路径 |
| --ca | ca 证书的文件路径 |
| --insecure | 取消服务器的证书校验 |
| -up, --user-properties <USERPROPERTIES...> | MQTT 5.0 用户属性，例如：-up "name: mqttx cli" |
| --will-topic <TOPIC> | 遗嘱消息的 topic |
| --will-message <BODY> | 遗嘱消息的 payload |
| --will-qos <0/1/2> | 遗嘱消息的 QoS |
| --will-retain | 遗嘱消息的 retain 标志位 |
| --help | 展示 pub 命令的帮助信息 |

## 与 EMQX 更好的合作

Expand All @@ -200,7 +240,7 @@ Node 环境的推荐版本:

- v14.\*.\*

``` shell
```shell
# 克隆项目
git clone git@github.com:emqx/MQTTX.git

Expand All @@ -215,7 +255,7 @@ yarn run dev
yarn run build
```

构建成功后，会在 `libs` 目录里出现构建成功的相应的文件，需要在 Node.js 环境中使用。
构建成功后，会在 `dist` 目录里出现构建成功的相应的文件，需要在 Node.js 环境中使用。

如果需要打包一个二进制可执行文件，请参考以下命令：

Expand Down
Loading

0 comments on commit 9f5b812

Please sign in to comment.