Skip to content

[fix][doc] Optimize URLs for CLI tools page #18101

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

Merged
codelipenghui merged 2 commits into from
Oct 27, 2022
Merged

[fix][doc] Optimize URLs for CLI tools page #18101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d43b1d4
[fix][doc] Optimize URLS for CLI tools page
Anonymitaet Oct 19, 2022
a800c34
update
Anonymitaet Oct 25, 2022
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
2 changes: 1 addition & 1 deletion site2/docs/about.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ You’ll notice an Edit button at the bottom and top of each page. Click it to o

:::tip

For how to make contributions to documentation, see [Pulsar Documentation Contribution Guide](https://docs.google.com/document/d/11DTnNPpvcPrebLkMAFcDEIFlD8ARD-k6F-LXoIwdD9Y/edit#).
For how to make contributions to documentation, see [Pulsar Documentation Contribution Guide](https://github.com/apache/pulsar/blob/master/site2/README.md).

:::

Expand Down
25 changes: 14 additions & 11 deletions site2/docs/reference-cli-tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,24 @@ sidebar_label: "Pulsar CLI tools"

Pulsar offers several command-line tools that you can use for managing Pulsar installations, performance testing, using command-line producers and consumers, and more.

* [`pulsar-admin`](https://pulsar.apache.org/reference/#/latest/pulsar-admin/)
* [`pulsar`](https://pulsar.apache.org/reference/#/latest/pulsar/)
* [`pulsar-client`](https://pulsar.apache.org/reference/#/latest/pulsar-client/)
* [`pulsar-perf`](https://pulsar.apache.org/reference/#/latest/pulsar-perf/)
* [`pulsar-daemon`](reference-cli-pulsar-daemon.md)
* [`pulsar-shell`](reference-cli-pulsar-shell.md)
* [`bookkeeper`](reference-cli-bookkeeper.md)
* [`broker-tool`](reference-cli-broker-tool.md)
* `pulsar-admin`
* `pulsar`
* `pulsar-client`
* `pulsar-daemon`
* `pulsar-perf`
* `pulsar-shell`
* `bookkeeper`

::: tip

For the latest and complete information about command-line tools, including commands, flags, descriptions, and more information, see [Pulsar Reference](https://pulsar.apache.org/reference).

:::

All Pulsar command-line tools can be run from the `bin` directory of your [installed Pulsar package](getting-started-standalone.md).

You can get help for any CLI tool, command, or subcommand using the `--help` flag, or `-h` for short. Here's an example:

```shell
bin/pulsar broker --help
```


```