Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(cli): update cli readme #1543

Merged
merged 1 commit into from
Dec 28, 2023
Merged

docs(cli): update cli readme #1543

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,14 @@ To install the latest MQTTX CLI stable release on **macOS** using **binary downl
#### Intel Chip

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

#### Apple Silicon

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

Expand All @@ -62,14 +62,14 @@ To install the latest MQTTX CLI stable release on **Linux** using **binary downl
#### x86-64

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

#### ARM64

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

Expand Down Expand Up @@ -214,6 +214,7 @@ mqttx conn --help
| --no-req-problem-info | the client requests problem information from the server |
| --save \[PATH\] | save the parameters to the local configuration file, which supports json and yaml format, default path is `./mqttx-cli-config.json` |
| --config \[PATH\] | load the parameters from the local configuration file, which supports json and yaml format, default path is `./mqttx-cli-config.json` |
| --debug | Enable debug mode for MQTT.js (default: false) |
| --help | display help for conn command |

### Subscribe
Expand Down Expand Up @@ -274,6 +275,7 @@ mqttx sub --help
| --help | display help for sub command |
| -Pp, --protobuf-path <PATH> | the path to the .proto file that defines the message format for Protocol Buffers (protobuf) |
| -Pmn, --protobuf-message-name <NAME> | the name of the protobuf message type (must exist in the .proto file) |
| --debug | Enable debug mode for MQTT.js (default: false) |

### Publish

Expand Down Expand Up @@ -337,6 +339,7 @@ mqttx pub --help
| --help | display help for pub command |
| -Pp, --protobuf-path <PATH> | the path to the .proto file that defines the message format for Protocol Buffers (protobuf) |
| -Pmn, --protobuf-message-name <NAME> | the name of the protobuf message type (must exist in the .proto file) |
| --debug | Enable debug mode for MQTT.js (default: false) |

### Benchmark

Expand Down
Loading