Plugins¶

Tunnel provides a plugin feature to allow others to extend the Tunnel CLI without the need to change the Tunnel code base. This plugin system was inspired by the plugin system used in kubectl, Helm, and Conftest.

Overview¶

Tunnel plugins are add-on tools that integrate seamlessly with Tunnel. They provide a way to extend the core feature set of Tunnel, but without requiring every new feature to be written in Go and added to the core tool.

They can be added and removed from a Tunnel installation without impacting the core Tunnel tool.
They can be written in any programming language.
They integrate with Tunnel, and will show up in Tunnel help and subcommands.

Warning

Tunnel plugins available in public are not audited for security. You should install and run third-party plugins at your own risk, since they are arbitrary programs running on your machine.

Quickstart¶

Tunnel helps you discover and install plugins on your machine.

You can install and use a wide variety of Tunnel plugins to enhance your experience.

Let’s get started:

Download the plugin list:
```
$ tunnel plugin update
```

Discover Tunnel plugins available on the plugin index:

$ tunnel plugin search
NAME                 DESCRIPTION                                                  MAINTAINER           OUTPUT
khulnasoft                 A plugin for integration with Khulnasoft Security SaaS platform    khulnasoft
kubectl              A plugin scanning the images of a kubernetes resource        khulnasoft
referrer             A plugin for OCI referrers                                   khulnasoft           ✓
[...]

Choose a plugin from the list and install it:
```
$ tunnel plugin install referrer
```
Use the installed plugin:
```
$ tunnel referrer --help
```
Keep your plugins up-to-date:
```
$ tunnel plugin upgrade
```
Uninstall a plugin you no longer use:
```
tunnel plugin uninstall referrer
```

This is practically all you need to know to start using Tunnel plugins.