Home

Awesome

<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->

Language LICENSE GoDoc

Pulsarctl

A CLI tool for the Apache Pulsar project.

Install pulsarctl

Mac operation system

Use homebrew to install pulsarctl on the Mac operation system.

brew tap streamnative/streamnative
brew install pulsarctl

Linux operation system

Use this command to install pulsarctl on the Linux operation system.

sh -c "$(curl -fsSL https://raw.githubusercontent.com/streamnative/pulsarctl/master/install.sh)"

Windows operation system

To install pulsarctl on the Windows operation system, follow these steps:

  1. Download the package from here.
  2. Add the pulsarctl directory to your system PATH.
  3. Type pulsarctl -h at CMD to verify that pulsarctl is work.

As project dependency

Use go get to install the pulsarctl as dependency on your project:

# Using master branch
go get github.com/streamnative/pulsarctl@master

# Or using v2.10.1.3 tag
go get github.com/streamnative/pulsarctl@v2.10.1.3

# Or using v2.9.3.3 tag
go get github.com/streamnative/pulsarctl@v2.9.3.3

Note: We will not release v0.y.z tags, so you need to specify the branch or tag.

Build pulsarctl from codes

Prerequisite

Steps

  1. Download codes.

    1. Clone the project from GitHub to your local.

      git clone https://github.com/streamnative/pulsarctl.git

    2. Use go mod to get the dependencies needed for the project.

      go mod download

      After 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.

  2. Build pulsarctl

    make pulsarctl

    If 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

Enable Auto-Completion

If you want to enable autocompletion in shell, see enable_completion.

Use contexts

If you want to cache information of multiple clusters, and can switch between multiple clusters, see How to use pulsarctl context.

Project Status

The following is an incomplete list of features that are not yet implemented:

Functions

Sources

Sinks

Schemas

Namespaces

Bookies

Different With Java Pulsar Admin

We move the subscription commands from the topics to the subscriptions in pulsarctl.

pulsar-adminpulsarctl
bin/pulsar-admin topics create-subscriptionpulsarctl subscription create
bin/pulsar-admin topics unsubscribepulsarctl subscription delete
bin/pulsar-admin topics skippulsarctl subscription skip
bin/pulsar-admin topics expire-messagespulsarctl subscription expire
bin/pulsar-admin topics peek-messagespulsarctl subscription peek
bin/pulsar-admin topics reset-cursorpulsarctl subscription seek
bin/pulsar-admin topics subscriptionspulsarctl subscription list

Contribute

Contributions are welcomed and greatly appreciated. For more information about how to submit a patch and the contribution workflow, see CONTRIBUTING.md.

License

Licensed under the Apache License Version 2.0: http://www.apache.org/licenses/LICENSE-2.0