trivy CLI reference

ModularPipelines.Trivy provides strongly typed access to the trivy CLI.

Executable prerequisite

This package does not install the trivy executable. Install it separately and ensure trivy is available on PATH.

Follow the executable's official documentation for installation instructions.

Package installation

dotnet add package ModularPipelines.Trivy

Resolve the service with context.Tools.Trivy. Projects using C# 13 or another .NET language can use context.Tools.Get<ModularPipelines.Trivy.Services.ITrivy>() instead.

Module example

Resolve the service in a module, then select a command from the table below. A runnable example is omitted when no command has complete safety metadata:

var trivy = context.Tools.Trivy;

Global options

Global options are rendered before the selected subcommand.

CLI option	Property	Availability	Description
--cacert	Cacert	All editions	Path to PEM-encoded CA certificate file
--cache-dir	CacheDir	All editions	cache directory (default "<cache>/trivy")
--config	Config	All editions	config path (empty string disables loading) (default "trivy.yaml")
--debug	Debug	All editions	debug mode
--generate-default-config	GenerateDefaultConfig	All editions	write the default config to trivy-default.yaml
--insecure	Insecure	All editions	allow insecure server connections
--quiet	Quiet	All editions	suppress progress bar and log output
--timeout	Timeout	All editions	timeout (default 5m0s)

Commands

CLI command	Options record
trivy clean	TrivyCleanOptions
trivy config	TrivyConfigOptions
trivy convert	TrivyConvertOptions
trivy filesystem	TrivyFilesystemOptions
trivy image	TrivyImageOptions
trivy kubernetes	TrivyKubernetesOptions
trivy module	TrivyModuleOptions
trivy module install	TrivyModuleInstallOptions
trivy module uninstall	TrivyModuleUninstallOptions
trivy plugin	TrivyPluginOptions
trivy plugin info	TrivyPluginInfoOptions
trivy plugin install	TrivyPluginInstallOptions
trivy plugin list	TrivyPluginListOptions
trivy plugin run	TrivyPluginRunOptions
trivy plugin search	TrivyPluginSearchOptions
trivy plugin uninstall	TrivyPluginUninstallOptions
trivy plugin update	TrivyPluginUpdateOptions
trivy plugin upgrade	TrivyPluginUpgradeOptions
trivy registry	TrivyRegistryOptions
trivy registry login	TrivyRegistryLoginOptions
trivy registry logout	TrivyRegistryLogoutOptions
trivy repository	TrivyRepositoryOptions
trivy rootfs	TrivyRootfsOptions
trivy sbom	TrivySbomOptions
trivy server	TrivyServerOptions
trivy version	TrivyVersionOptions
trivy vex	TrivyVexOptions
trivy vex repo	TrivyVexRepoOptions
trivy vex repo download	TrivyVexRepoDownloadOptions
trivy vex repo init	TrivyVexRepoInitOptions
trivy vex repo list	TrivyVexRepoListOptions
trivy vm	TrivyVmOptions