Pulsarctl

https://github.com/streamnative/pulsarctl
Admin
A command-line tool for managing and administering Apache Pulsar clusters, with support for topics,...
Tokens:73,763
Snippets:487
Trust Score:9.8
License:Apache-2.0
Update:1 day ago
Show doc for...
Tokens:
Raw
### CreateTopicCmd and doCreateTopic functions

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/developer-guide.md

Example structure for a command file: CreateTopicCmd sets up command description, examples, output, and run function; doCreateTopic creates a Pulsar client and calls the Topics().Create method. Requires namespace admin permissions.

```go
func CreateTopicCmd(vc *cmdutils.VerbCmd) {
	var desc pulsar.LongDescription
	desc.CommandUsedFor = "This command is used for creating topic."
	desc.CommandPermission = "This command requires namespace admin permissions."

	var examples []pulsar.Example
	createNonPartitions := pulsar.Example{
		Desc:    "Create a non-partitioned topic <topic-name>",
		Command: "Pulsarctl topics create <topic-name> 0",
	}
	examples = append(examples, createNonPartitions)
	desc.CommandExamples = examples

	var out []pulsar.Output
	successOut := pulsar.Output{
		Desc: "normal output",
		Out:  "Create topic <topic-name> with <partition-num> partitions successfully",
	}
	out = append(out, successOut)
	desc.CommandOutput = out

	vc.SetDescription(
		"create",
		"Create a topic with n partitions",
		desc.ToString(),
		desc.ExampleToString(),
		"c")

	vc.SetRunFuncWithMultiNameArgs(func() error {
		return doCreateTopic(vc)
	}, CheckTopicNameTwoArgs)
}

func doCreateTopic(vc *cmdutils.VerbCmd) error {
	admin := cmdutils.NewPulsarClient()
	err = admin.Topics().Create(*topic, partitions)
	if err == nil {
		vc.Command.Printf("Create topic %s with %d partitions successfully\n", topic.String(), partitions)
	}

	return err
}
```

--------------------------------

### Build pulsarctl with make

Source: https://github.com/streamnative/pulsarctl/blob/master/README.md

Builds the pulsarctl binary using the Makefile. Requires Go 1.11 or higher.

```bash
make pulsarctl
```

--------------------------------

### Install pulsarctl as Go project dependency

Source: https://github.com/streamnative/pulsarctl/blob/master/README.md

Use go get to add pulsarctl as a dependency. Specify a branch or tag; v0.y.z tags are not released.

```shell
# 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
```

--------------------------------

### Download dependencies with go mod

Source: https://github.com/streamnative/pulsarctl/blob/master/README.md

Downloads the project dependencies using Go modules. If some libraries cannot be downloaded, refer to the proxy provided by GOPROXY.io.

```bash
go mod download
```

--------------------------------

### pulsarctl topics list example

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Example command listing topics in a namespace. The name argument is case-sensitive.

```bash
pulsarctl topics list public/default
```

--------------------------------

### Clone the pulsarctl repository

Source: https://github.com/streamnative/pulsarctl/blob/master/README.md

Clones the pulsarctl project from GitHub to your local machine. Required before building.

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

--------------------------------

### Install pulsarctl on Linux using curl script

Source: https://github.com/streamnative/pulsarctl/blob/master/README.md

Install pulsarctl on Linux by running the official installation script via curl.

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

--------------------------------

### Print pulsarctl version

Source: https://github.com/streamnative/pulsarctl/blob/master/README.md

Displays the version information of the built pulsarctl binary. The output includes release version, git commit hash, branch, build time, and Go version.

```bash
bin/pulsarctl --version
```

```text
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
```

--------------------------------

### Use TLS flags with pulsarctl topics list

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Example command using TLS flags: --admin-service-url, --auth-params with tlsCertFile and tlsKeyFile, --tls-allow-insecure, and --tls-trust-cert-path. Lists topics in public/default.

```bash
pulsarctl \
    --admin-service-url https://localhost:8443 \
    --auth-params "{\"tlsCertFile\":\"/test/auth/certs/client-cert.pem\",\"tlsKeyFile\":\"/test/auth/certs/client-key.pem\"}" \
	--tls-allow-insecure \
	--tls-trust-cert-path /test/auth/certs/cacert.pem \
	topics list public/default
```

--------------------------------

### Install pulsarctl on macOS using Homebrew

Source: https://github.com/streamnative/pulsarctl/blob/master/README.md

Use Homebrew to install pulsarctl on macOS. Requires Homebrew to be installed.

```bash
brew tap streamnative/streamnative
brew install pulsarctl
```

--------------------------------

### Install bash-completion v2 with Homebrew

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/enable_completion.md

Installs bash-completion v2, which is required for pulsarctl completion on Bash 4.1+.

```bash
brew install bash-completion@2
```

--------------------------------

### Go Admin API Example for Listing Clusters

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Complete Go program using the pulsarctl admin API to list clusters. It creates a client with the WebServiceURL and optional authentication, then calls Clusters().List(). The default client uses v2 APIs; specify a different API version with NewPulsarClientWithAPIVersion.

```go
package main

import (
    "fmt"
    "net/http"

    "github.com/streamnative/pulsarctl/pkg/pulsar"
)

func main() {
    config := &pulsar.Config{
        WebServiceURL: "http://localhost:8080",
        HTTPClient:    http.DefaultClient,

        // If the server enable the TLSAuth
        // Auth: auth.NewAuthenticationTLS()

        // If the server enable the TokenAuth
        // TokenAuth: auth.NewAuthenticationToken()
    }

    // the default NewPulsarClient will use v2 APIs. If you need to request other version APIs,
    // you can specified the API version like this:
    // admin := cmdutils.NewPulsarClientWithAPIVersion(pulsar.V2)
    admin, err := pulsar.New(config)
    if err != nil {
        // handle the err
        return
    }

    // more APIs, you can find them in the pkg/pulsar/admin.go
    // You can find all the method in the pkg/pulsar
    clusters, err := admin.Clusters().List()
    if err != nil {
        // handle the error
        return
    }

    // handle the result
    fmt.Println(clusters)
}
```

--------------------------------

### Use --token-file flag with pulsarctl topics list

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Example command using the --token-file flag to specify a token file path for JWT authentication and list topics in public/default.

```bash
pulsarctl \
    --token-file file:///test/auth/tokens/token
    topics list public/default
```

--------------------------------

### Example pulsarctl-foo plugin script

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/how-to-extend-pulsarctl-with-plugins.md

A bash script that implements the pulsarctl-foo plugin. It checks the first argument and prints a message accordingly, exiting with status 0 when the argument is 'args'.

```bash
#!/bin/bash

if [[ $1 == "args" ]]
then 
    echo "I am the args of the pulsarctl-foo"
    exit 0
fi

echo "I am a plugin named pulsarctl-foo"
```

--------------------------------

### Generate and install Zsh completion script

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/enable_completion.md

Creates the completion directory, generates the pulsarctl Zsh completion script, and writes it to ~/.zsh/completion/_pulsarctl.

```bash
mkdir -p ~/.zsh/completion/
pulsarctl completion zsh > ~/.zsh/completion/_pulsarctl
```

--------------------------------

### Use --token flag with pulsarctl topics list

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Example command using the --token flag with a JWT string to authenticate and list topics in public/default.

```bash
pulsarctl \
    --token "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0LXVzZXIifQ.Yb52IE0B5wzooAdSlIlskEgb6_HBXST8k3lINZS5wwg" \
    topics list public/default
```

--------------------------------

### List contexts with pulsarctl context get

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/how-to-use-context.md

Lists all defined contexts with their broker and bookie service URLs. The output table marks the current context with an asterisk (*) in the CURRENT column.

```bash
$ pulsarctl context get
```

```text
+---------+-------------+---------------------+---------------------+
| CURRENT |    NAME     | BROKER SERVICE URL  | BOOKIE SERVICE URL  |
+---------+-------------+---------------------+---------------------+
|         | development | http://1.2.3.4:8080 | http://1.2.3.4:8083 |
|   *     | scratch     | http://5.6.7.8:8080 | http://5.6.7.8:8083 |
+---------+-------------+---------------------+---------------------+
```

--------------------------------

### Delete a context with pulsarctl context delete

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/how-to-use-context.md

Deletes the specified context (scratch in this example) when its cluster information is no longer valid.

```bash
$ pulsarctl context delete scratch
```

--------------------------------

### Switch to a context with pulsarctl context use

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/how-to-use-context.md

Switches the current context to the specified cluster (scratch in this example). After running this command, pulsarctl uses the context and auth info of that cluster. Validate the current context with `pulsarctl context current`.

```bash
$ pulsarctl context use scratch
```

--------------------------------

### Topics Interface and Create Implementation

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/developer-guide.md

Shows the Topics interface and its Create method implementation, which sends a PUT request to the endpoint. If partitions is 0, the endpoint omits the 'partitions' path segment.

```go
type Topics interface {
	Create(TopicName, int) error
}

// define topics struct and implement the Topics interface
func (t *topics) Create(topic TopicName, partitions int) error {
	endpoint := t.client.endpoint(t.basePath, topic.GetRestPath(), "partitions")
	if partitions == 0 {
		endpoint = t.client.endpoint(t.basePath, topic.GetRestPath())
	}
	return t.client.put(endpoint, partitions, nil)
}
```

--------------------------------

### Create topic command files

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/developer-guide.md

Creates create.go and topic.go in the topic directory. create.go holds topic creation logic, topic.go stores all topic-related commands.

```bash
cd pkg/ctl/topic
touch create.go topic.go
```

--------------------------------

### Create topic directory

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/developer-guide.md

Creates the topic folder under the ctl directory as the first step in adding a new command.

```bash
mkdir topic
```

--------------------------------

### Single-Line Text Output with Printf

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/developer-guide.md

Prints a single-line success message using Printf, including the topic name and partition count.

```go
vc.Command.Printf("Create topic %s with %d partitions successfully\n", topic.String(), partitions)
```

--------------------------------

### Output flags help text

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/developer-guide.md

Shows the flagset defined for output configuration, with available formats text, json, and yaml. The default output format is text.

```text
Output flags:
  -o, --output string   The output format (text,json,yaml) (default "text")
```

--------------------------------

### Enable output flagset in VerbCmd

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/developer-guide.md

Call this during initialization of a VerbCmd to enable the output flagset. Most commands set a description, run function, and optionally define a flagset; enable output last.

```go
vc.EnableOutputFlagSet()
```

--------------------------------

### Topic Command Definition

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/developer-guide.md

Defines the 'topics' resource command and adds the CreateTopicCmd verb command via AddVerbCmds.

```go
func Command(flagGrouping *cmdutils.FlagGrouping) *cobra.Command {
	resourceCmd := cmdutils.NewResourceCmd(
		"topics",
		"Operations about topic(s)",
		"",
		"topic")

	commands := []func(*cmdutils.VerbCmd){
		CreateTopicCmd,
	}

	cmdutils.AddVerbCmds(flagGrouping, resourceCmd, commands...)

	return resourceCmd
}
```

--------------------------------

### Move plugin to PATH

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/how-to-extend-pulsarctl-with-plugins.md

Places the pulsarctl-foo executable in /usr/local/bin, which is on the PATH.

```bash
mv pulsarctl-foo /usr/local/bin
```

--------------------------------

### FlagSetGroup for specifying flags

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/developer-guide.md

Shows how to define a flag set for a command using vc.FlagSetGroup.InFlagSet. Use JSON tags for parameter names and YAML tags for YAML parameters. Mark required flags with cobra.MarkFlagRequired.

```go
vc.FlagSetGroup.InFlagSet("Topic", func(set *pflag.FlagSet) {
    set.BoolVarP(&partition, 
    "partitioned-topic", 
    "p", 
    false,
    "Get the partitioned topic stats")
    
    // other flags    
})
```

--------------------------------

### Invoke plugin with args

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/how-to-extend-pulsarctl-with-plugins.md

Runs the pulsarctl-foo plugin with the argument 'args', producing the output shown.

```bash
pulsarctl foo args
```

```text
I am the args of the pulsarctl-foo
```

--------------------------------

### Client Interface Definition

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/developer-guide.md

Defines the Client interface with a Topics() method, used as the base for topic-related subcommands in pulsarctl.

```go
type Client interface {
	Topics() Topics
}
```

--------------------------------

### Make plugin executable

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/how-to-extend-pulsarctl-with-plugins.md

Makes the pulsarctl-foo script executable.

```bash
chmod +x ./pulsarctl-foo
```

--------------------------------

### Check pulsar context configuration file

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/how-to-use-context.md

Displays the contents of the pulsar configuration file at $HOME/.config/pulsar after defining contexts. The output shows the auth-info and contexts sections for both clusters, with the current-context initially empty.

```bash
$ cat $HOME/.config/pulsar
```

```text
auth-info:
  development:
    locationoforigin: $HOME/.config/pulsar
    tls_trust_certs_file_path: ""
    tls_allow_insecure_connection: false
    token: ""
    tokenFile: ""
  scratch:
    locationoforigin: $HOME/.config/pulsar
    tls_trust_certs_file_path: ""
    tls_allow_insecure_connection: false
    token: ""
    tokenFile: ""
contexts:
  development:
    admin-service-url: http://1.2.3.4:8080
    bookie-service-url: http://1.2.3.4:8083
  scratch:
    admin-service-url: http://5.6.7.8:8080
    bookie-service-url: http://5.6.7.8:8083
current-context: ""
```

--------------------------------

### Configure bash-completion in ~/.bashrc

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/enable_completion.md

Adds the bash-completion compatibility directory and sources the bash_completion.sh script.

```bash
export BASH_COMPLETION_COMPAT_DIR="/usr/local/etc/bash_completion.d"
[[ -r "/usr/local/etc/profile.d/bash_completion.sh" ]] && . "/usr/local/etc/profile.d/bash_completion.sh"
```

--------------------------------

### Clone repository and create release branch and tag

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/release_process.md

Commands to clone the repository, create a release branch from master, and create a signed tag. Use a fresh clone to avoid local file interference. Replace x.y.z with the actual release version.

```shell
$ git clone git@github.com:streamnattive/pulsarctl.git
$ cd pulsarctl

# Create a branch
$ git checkout -b branch-x.y.z origin/master

# Create a tag
$ git tag -u $USER@streamnative.io vx.y.z -m 'Release vx.y.z'
```

--------------------------------

### Enable JWT in broker.conf or standalone.conf

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Set authenticationEnabled to true and configure AuthenticationProviderToken with a secret key file to enable JWT authentication on the broker.

```properties
# Enable JWT

# Enable authentication
authenticationEnabled=true

# Autentication provider name list, which is comma separated list of class names
authenticationProviders=org.apache.pulsar.broker.authentication.AuthenticationProviderToken

# Configure the secret key to be used to validate auth tokens
tokenSecretKey=file:///test/auth/token/secret.key
```

--------------------------------

### Invoke plugin without args

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/how-to-extend-pulsarctl-with-plugins.md

Runs the pulsarctl-foo plugin without arguments, producing the output shown.

```bash
pulsarctl foo
```

```text
I am a plugin named pulsarctl-foo
```

--------------------------------

### pulsarctl help output showing common flags

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Output of `pulsarctl help` listing common flags including TLS and JWT authentication options. Shows default admin service URL, auth params format, and log level default.

```text
Common flags:
  -s, --admin-service-url string    The admin web service url that pulsarctl connects to. (default "http://localhost:8080")
      --auth-params string          Authentication parameters are used to configure the public and private key files required by tls
                                     For example: "tlsCertFile:val1,tlsKeyFile:val2"
  -C, --color string                toggle colorized logs (true,false,fabulous) (default "true")
  -h, --help                        help for this command
      --tls-allow-insecure          Allow TLS insecure connection
      --tls-trust-cert-path string   Allow TLS trust cert file path
      --token string                Using the token to authentication
      --token-file string           Using the token file to authentication
  -v, --verbose int                 set log level, use 0 to silence, 4 for debugging (default 3)
```

--------------------------------

### Set contexts and auth info with pulsarctl context set

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/how-to-use-context.md

Defines two clusters (development and scratch) with their admin and bookie service URLs. The command caches the cluster information in $HOME/.config/pulsar. Auth info can be set with flags --token, --token-file, --tls-trust-cert-path, and --tls-allow-insecure.

```bash
$ pulsarctl context set development --admin-service-url="http://1.2.3.4:8080" --bookie-service-url="http://1.2.3.4:8083"
$ pulsarctl context set scratch --admin-service-url="http://5.6.7.8:8080" --bookie-service-url="http://5.6.7.8:8083"
```

--------------------------------

### pulsarctl subscriptions command syntax

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Operations on subscriptions. The resource argument is required.

```bash
pulsarctl subscriptions [sub-command] [name] [flags]
```

--------------------------------

### pulsarctl sources command syntax

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Interface for managing Pulsar IO sources (ingress data into Pulsar). The resource argument is required.

```bash
pulsarctl sources [sub-command] [name] [flags]
```

--------------------------------

### Push release branch and tag to GitHub

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/release_process.md

Commands to push the release branch and the tag to the GitHub repository. Run after creating the branch and tag.

```shell
# Push both the branch and the tag to Github repo
$ git push origin branch-x.y.z
$ git push origin vx.y.z
```

--------------------------------

### pulsarctl broker-stats command syntax

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Collect broker statistics. The resource argument is required.

```bash
pulsarctl broker-stats [sub-command] [name] [flags]
```

--------------------------------

### pulsarctl schemas command syntax

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Operations on schemas. The resource argument is required.

```bash
pulsarctl schemas [sub-command] [name] [flags]
```

--------------------------------

### pulsarctl brokers command syntax

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Operations on brokers. The resource argument is required.

```bash
pulsarctl brokers [sub-command] [name] [flags]
```

--------------------------------

### Enable TLS in broker.conf or standalone.conf

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Set tlsEnabled to true in the broker configuration file to enable TLS on the broker. Includes certificate and key file paths, trust certs, and disables insecure connections.

```properties
# Enable TLS

tlsEnabled=true
tlsCertificateFilePath=/test/auth/certs/broker-cert.pem
tlsKeyFilePath=/test/auth/certs/broker-key.pem
tlsTrustCertsFilePath=/test/auth/certs/cacert.pem
tlsAllowInsecureConnection=false
```

--------------------------------

### pulsarctl namespaces command syntax

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Operations on namespaces. The resource argument is required.

```bash
pulsarctl namespaces [sub-command] [name] [flags]
```

--------------------------------

### pulsarctl command usage syntax

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/developer-guide.md

Shows the general usage pattern for pulsarctl commands: pulsarctl [commands] [sub commands] [flags]. The command names correspond to directories under the ctl directory.

```bash
pulsarctl [commands] [sub commands] [flags]
```

--------------------------------

### Load Fish completion for current session

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/enable_completion.md

Loads pulsarctl completions once in the current Fish session.

```bash
pulsarctl completion fish | source
```

--------------------------------

### Contribution flow: sync fork and create PR branch

Source: https://github.com/streamnative/pulsarctl/blob/master/CONTRIBUTING.md

Commands to sync your fork with the remote master and create a branch for a pull request. Run these in order after forking the repository.

```bash
$ git remote add streamnative https://github.com/streamnative/pulsarctl.git
# sync with the remote master
$ git checkout master
$ git fetch streamnative
$ git rebase streamnative/master
$ git push origin master
# create a PR branch
$ git checkout -b your_branch   
# do something
$ git add [your change files]
$ git commit -sm "xxx"
$ git push origin your_branch
```

--------------------------------

### pulsarctl topics command syntax

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Operations on persistent topics. The resource argument is required.

```bash
pulsarctl topics [sub-command] [name] [flags]
```

--------------------------------

### pulsarctl tenants command syntax

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Operations on tenants. The resource argument is required.

```bash
pulsarctl tenants [sub-command] [name] [flags]
```

--------------------------------

### Force rebuild zcompdump

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/enable_completion.md

Removes the zcompdump file and reinitializes completion to force a rebuild.

```bash
rm -f ~/.zcompdump; compinit
```

--------------------------------

### pulsarctl resource-quotas command syntax

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Operations on resource quotas. The resource argument is required.

```bash
pulsarctl resource-quotas [sub-command] [name] [flags]
```

--------------------------------

### Add Zsh completion directory to fpath

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/enable_completion.md

Adds the completion directory to the fpath in ~/.zshrc and reloads the shell configuration.

```bash
fpath=($fpath ~/.zsh/completion)
source ~/.zshrc
```

--------------------------------

### pulsarctl command syntax

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Use this syntax to run pulsarctl commands from the terminal. The resource, command, and name arguments are required; flags are optional.

```bash
pulsarctl [resource] [command] [name] [flags]
```

--------------------------------

### Tablewriter Usage for Tabular Output

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/developer-guide.md

Uses the tablewriter library to print a table with a header 'Pulsar Function Name' and appends each function name as a row.

```go
table := tablewriter.NewWriter(vc.Command.OutOrStdout())
table.SetHeader([]string{"Pulsar Function Name"})

for _, f := range functions {
    table.Append([]string{f})
}

table.Render()
```

--------------------------------

### pulsarctl functions command syntax

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Interface for managing Pulsar Functions (lightweight, Lambda-style compute processes that work with Pulsar). The resource argument is required.

```bash
pulsarctl functions [sub-command] [name] [flags]
```

--------------------------------

### pulsarctl clusters command syntax

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Operations on clusters. The resource argument is required.

```bash
pulsarctl clusters [sub-command] [name] [flags]
```

--------------------------------

### Generate Bash completion script

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/enable_completion.md

Generates the pulsarctl Bash completion script and writes it to the bash-completion directory.

```bash
pulsarctl completion bash >/usr/local/etc/bash_completion.d/pulsarctl.bash
```

--------------------------------

### Persist Fish completion script

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/enable_completion.md

Generates the pulsarctl Fish completion script and writes it to the Fish completions directory for each session.

```bash
pulsarctl completion fish > ~/.config/fish/completions/pulsarctl.fish
```

--------------------------------

### Source Bash completion script in ~/.bashrc

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/enable_completion.md

Adds a source line for the pulsarctl completion script to ~/.bashrc and sources it immediately.

```bash
echo 'source /usr/local/etc/bash_completion.d/pulsarctl.bash' >> ~/.bashrc
source ~/.bashrc
```

--------------------------------

### Error Handler Override for Testing

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/developer-guide.md

Overrides cmdutils.ExecErrorHandler to capture errors into a variable instead of exiting, useful for testing error scenarios.

```go
var execError error
cmdutils.ExecErrorHandler = func(err error) {
	execError = err
}
```

--------------------------------

### pulsarctl ns-isolation-policy command syntax

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Operations on namespace isolation policy. The resource argument is required.

```bash
pulsarctl ns-isolation-policy [sub-command] [name] [flags]
```

--------------------------------

### pulsarctl sinks command syntax

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Interface for managing Pulsar IO sinks (egress data from Pulsar). The resource argument is required.

```bash
pulsarctl sinks [sub-command] [name] [flags]
```

--------------------------------

### Cluster List Interface Definition

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Defines the Go interface for listing clusters via the Pulsar admin API. The method returns a slice of cluster names and an error.

```go
// List returns the list of clusters
List() ([]string, error)
```

--------------------------------

### Rename a context with pulsarctl context rename

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/how-to-use-context.md

Renames an existing context from old_name to new_name. Useful when the current context name was defined incorrectly.

```bash
$ pulsarctl context rename old_name new_name
```

--------------------------------

### pulsarctl functions-worker command syntax

Source: https://github.com/streamnative/pulsarctl/blob/master/docs/en/overview_of_pulsarctl.md

Collect function-worker statistics. The resource argument is required.

```bash
pulsarctl functions-worker [sub-command] [name] [flags]
```
Tokens:
Raw