A CLI tool for the Apache Pulsar project.
| Version | Reference |
|---|---|
| 0.5.0 | Command Reference |
| 0.4.1 | Command Reference |
| 0.4.0 | Command Reference |
| 0.3.0 | Command Reference |
| 0.2.0 | Command Reference |
| 0.1.0 | Command Reference |
You can install pulsarctl using homebrew on Mac.
brew tap streamnative/streamnativebrew install pulsarctlsh -c "$(curl -fsSL https://raw.githubusercontent.com/streamnative/pulsarctl/master/install.sh)"- Download the executable from https://github.com/streamnative/pulsarctl/releases.
- Add the pulsarctl directory to your system PATH.
- Type
pulsarctl -hat CMD to test pulsarctl is work.
- Go 1.11 +
If you have not installed Go, install it according to the installation instruction.
Since the go mod package management tool is used in this project, Go 1.11 or higher version is required.
- Clone the project from GitHub to your local.
git clone https://github.com/streamnative/pulsarctl.git- Use
go modto get the dependencies needed for the project.
go mod downloadAfter entering the go mod download command, if some libs can not be downloaded, then you can download them by referring to the proxy provided by GOPROXY.io.
make pulsarctlIf you want to print version of pulsarctl, you can use follow commands:
bin/pulsarctl --version
Output:
Release Version: v2.8.0.3
Git Commit Hash: add1e586e8d56fcc1cbd2fe94ed75b10d6c54672
Git Branch: HEAD
UTC Build Time: 2021-06-26 06:39:16
Go Version: go version go1.16.3 darwin/amd64
If you want to enable autocompletion in shell, see enable_completion.
If you want to cache information of multiple clusters, and can switch between multiple clusters, see How to use pulsarctl context.
The following is an incomplete list of features that are not yet implemented:
- localrun
- localrun
- available-sources
- reload
- localrun
- available-sources
- reload
- extract
- delete-bookie-affinity-group
- get-bookie-affinity-group
- set-bookie-affinity-group
- racks-placement
- get-bookie-rack
- delete-bookie-rack
- set-bookie-rack
We move the subscription commands from the Topics to the Subscriptions in pulsarctl.
| pulsar-admin | pulsarctl |
|---|---|
| bin/pulsar-admin topics create-subscription | pulsarctl subscription create |
| bin/pulsar-admin topics unsubscribe | pulsarctl subscription delete |
| bin/pulsar-admin topics skip | pulsarctl subscription skip |
| bin/pulsar-admin topics expire-messages | pulsarctl subscription expire |
| bin/pulsar-admin topics peek-messages | pulsarctl subscription peek |
| bin/pulsar-admin topics reset-cursor | pulsarctl subscription seek |
| bin/pulsar-admin topics subscriptions | pulsarctl subscription list |
Contributions are welcomed and greatly appreciated. For more information about how to submit a patch and the contribution workflow, see CONTRIBUTING.md.
Licensed under the Apache License Version 2.0: http://www.apache.org/licenses/LICENSE-2.0