momo-jun commented on code in PR #16725: URL: https://github.com/apache/pulsar/pull/16725#discussion_r927233368
########## site2/docs/administration-pulsar-shell.md: ########## @@ -0,0 +1,174 @@ +--- +id: administration-pulsar-shell +title: Pulsar Shell +sidebar_label: "Pulsar Shell" +--- + +````mdx-code-block +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +```` + + +Pulsar shell is a fast and flexible shell for Pulsar cluster management, messaging, and more. +It's great for quickly switching between different clusters, and can modify cluster or tenant configurations in an instant. + + +# Features +- Administration: find all the [Admin API](admin-api-overview.md) features under the `admin` command . +- Client: find all the [pulsar-client](reference-cli-tools#pulsar-client.md) features under the `client` command. + + +# Installation + +Download the tarball from the [download page](https://pulsar.apache.org/download) and extract it. + +```shell +wget https://archive.apache.org/dist/pulsar/pulsar-@pulsar:version@/apache-pulsar-shell-@pulsar:[email protected] +tar xzvf apache-pulsar-shell-@pulsar:[email protected] +cd apache-pulsar-shell-@pulsar:[email protected] +``` + +Now you can enter Pulsar shell's interactive mode: + +```shell +$ ./bin/pulsar-shell +Welcome to Pulsar shell! + Service URL: pulsar://localhost:6650/ + Admin URL: http://localhost:8080/ + +Type help to get started or try the autocompletion (TAB button). +Type exit or quit to end the shell session. + +default(localhost)> +``` + + +# Connect to your cluster + +By default, the shell will try to connect to a local Pulsar instance. Review Comment: ```suggestion By default, the shell tries to connect to a local Pulsar instance. ``` We use the simple present tense according to the [Pulsar Writing Style Guide](https://docs.google.com/document/d/1lc5j4RtuLIzlEYCBo97AC8-U_3Erzs_lxpkDuseU0n4/edit#heading=h.j0ohedastxh). -- 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]
