pulsarctl
) plugins enable you to extend the capabilities of the Pulsar CLI to interact with Pulsar resources. You can create simple and complex scripting workflows using the CLI and plugins.
To use plugins, you must have pulsarctl
installed.
pulsarctl-
.-
) in its filename. For example, a plugin named streamnative-this-command
would define the command streamnative this command
.-
) or underscores (_
), use an underscore (_
) in the plugin filenames in place of a dash (-
). For example, you can invoke a plugin whose filename is streamnative-that_command
by running the following commmand:
plugin list
command output will have a warning message that the offending plugin will be ignored.
$PATH
is used. The other plugins discovered with the same name are ignored.pulsarctl example arg1 --flag=val arg2
, the pulsarctl
will:
pulsarctl-example-arg1
.pulsarctl-example
since the pulsarctl-example-arg1
plugin is not found.pulsarctl-
meaning that no plugins matching the command have been found.arg1 --flag=val arg2
) as arguments to the plugin process, since pulsarctl-example
exists.pulsarctl
.
plugin list
command to search your PATH for plugin executables. This command lists plugin names in the order in which they are discovered.
pulsarctl
in StreamNative’s GitHub repository. You can also contribute a plugin for others to leverage as well. To do so, follow the steps to add a plugin.
pulsarctl-foo
.
pulsarctl-foo
executable:
PATH
: