momo-jun commented on code in PR #16725:
URL: https://github.com/apache/pulsar/pull/16725#discussion_r927233775
##########
site2/docs/reference-cli-tools.md:
##########
@@ -1015,3 +1016,127 @@ Options
|`-i`, `--interval`| Interval to collect load report, in milliseconds ||
|`-h`, `--help`| Display help information ||
+
+## `pulsar-shell`
+
+[Pulsar shell](administration-pulsar-shell.md) tool.
+
+### Interactive mode
+
+Usage
+
+```bash
+
+$ pulsar-shell
+
+```
+
+Options
+
+| Flag | Description
| Default |
+|--------------------|---------------------------------------------------------------------------|------------------|
+| `-c`, `--config` | Client configuration file. It will be used as `default`
config. | conf/client.conf |
+| `--fail-on-error` | If true, the shell will be interrupted if a command
throws an exception. | false |
Review Comment:
```suggestion
| `--fail-on-error` | If true, the shell is interrupted when a command
throws an exception. | false |
```
##########
site2/docs/reference-cli-tools.md:
##########
@@ -1015,3 +1016,127 @@ Options
|`-i`, `--interval`| Interval to collect load report, in milliseconds ||
|`-h`, `--help`| Display help information ||
+
+## `pulsar-shell`
+
+[Pulsar shell](administration-pulsar-shell.md) tool.
+
+### Interactive mode
+
+Usage
+
+```bash
+
+$ pulsar-shell
+
+```
+
+Options
+
+| Flag | Description
| Default |
+|--------------------|---------------------------------------------------------------------------|------------------|
+| `-c`, `--config` | Client configuration file. It will be used as `default`
config. | conf/client.conf |
+| `--fail-on-error` | If true, the shell will be interrupted if a command
throws an exception. | false |
+| `-h`, `--help` | Show this help
| |
+
+
+### Non interactive mode
+
+Usage
+
+```bash
+
+$ pulsar-shell -f [FILE]
+$ pulsar-shell -e [COMMAND]
+$ echo "[COMMAND]" | pulsar-shell -
+
+```
+
+Options
+
+| Flag | Description
| Default |
+|---------------------------|-----------------------------------------------------------------------------------------------------|-----------------|
+| `-c`, `--config` | Client configuration file. It will be used as
`default` config. | conf/client.conf |
Review Comment:
```suggestion
| `-c`, `--config` | Client configuration file. It is used as a
`default` config. | conf/client.conf |
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]