chore(cli): modify version & verbose options short flag

emqx · Jul 20, 2022 · b0d6a63 · b0d6a63
1 parent 24d4575
commit b0d6a63
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/cli/README-CN.md b/cli/README-CN.md
@@ -111,7 +111,7 @@ mqttx --help
 
 | 参数          | 描述                         |
 | ------------- | ---------------------------- |
-| -V, --version | 输出当前 MQTT X CLI 的版本号 |
+| -v, --version | 输出当前 MQTT X CLI 的版本号 |
 | -h, --help    | 展示 mqttx 命令的帮助信息    |
 
 | 命令 | 描述               |
@@ -145,7 +145,7 @@ mqttx sub --help
 | --will-message <BODY>  | 遗嘱消息的 payload                       |
 | --will-qos <0/1/2>     | 遗嘱消息的 QoS                           |
 | --will-retain          | 遗嘱消息的 retain 标志位                 |
-| -v, --verbose          | 在接收到的 Payload 前显示当前 Topic      |
+| -vb, --verbose         | 在接收到的 Payload 前显示当前 Topic      |
 | --help                 | 展示 sub 命令的帮助信息                  |
 
 #### 发布

diff --git a/cli/README.md b/cli/README.md
@@ -110,7 +110,7 @@ mqttx --help
 
 | Options       | Description               |
 | ------------- | ------------------------- |
-| -V, --version | output the version number |
+| -v, --version | output the version number |
 | -h, --help    | display help for command  |
 
 | Command | Description                  |
@@ -124,7 +124,7 @@ mqttx --help
 mqttx sub --help
 ```
 
-| Options                   | Description                                                         |
+| Options                | Description                                                  |
 | ---------------------- | ------------------------------------------------------------ |
 | -h, --hostname <HOST>  | the broker host (default: "localhost")                       |
 | -p, --port <PORT>      | the broker port                                              |
@@ -144,7 +144,7 @@ mqttx sub --help
 | --will-message <BODY>  | the will message                                             |
 | --will-qos <0/1/2>     | the will qos                                                 |
 | --will-retain          | send a will retained message (default: false)                |
-| -v, --verbose          | print the topic before the message                           |
+| -vb, --verbose         | print the topic before the message                           |
 | --help                 | display help for sub command                                 |
 
 #### Publish
@@ -153,7 +153,7 @@ mqttx sub --help
 mqttx pub --help
 ```
 
-| Options                   | Description                                                |
+| Options                | Description                                         |
 | ---------------------- | --------------------------------------------------- |
 | -h, --hostname <HOST>  | the broker host                                     |
 | -p, --port <PORT>      | the broker port                                     |

diff --git a/cli/src/index.ts b/cli/src/index.ts
@@ -13,7 +13,7 @@ export class Commander {
   }
 
   init(): void {
-    this.program.name('mqttx').description('An MQTT client for the command line').version(version)
+    this.program.name('mqttx').description('An MQTT client for the command line').version(version, '-v, --version')
 
     this.program
       .command('pub')
@@ -61,7 +61,7 @@ export class Commander {
       .option('--will-message <BODY>', 'the will message')
       .option('--will-qos <0/1/2>', 'the will qos', parseNumber)
       .option('--will-retain', 'send a will retained message', false)
-      .option('-v, --verbose', 'print the topic before the message')
+      .option('-vb, --verbose', 'print the topic before the message')
       .action(sub)
   }
 }