Plugins¶

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

Overview¶

Trivy plugins are add-on tools that integrate seamlessly with Trivy. They provide a way to extend the core feature set of Trivy, 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 Trivy installation without impacting the core Trivy tool.
They can be written in any programming language.
They integrate with Trivy, and will show up in Trivy help and subcommands.

Warning

Trivy 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¶

Trivy helps you discover and install plugins on your machine.

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

Let’s get started:

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

Discover Trivy plugins available on the plugin index:

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

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

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