Skip to main content
Version: Next

syft CLI reference

ModularPipelines.Syft provides strongly typed access to the syft CLI.

Executable prerequisite

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

See the syft installation guide.

Package installation

dotnet add package ModularPipelines.Syft

Resolve the service with context.Tools.Syft. For projects older than C# 14, import ModularPipelines.Syft.Extensions and use the context.Syft() extension method as a compatibility fallback.

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 syft = context.Tools.Syft;

Commands

CLI commandOptions record
syft attestSyftAttestOptions
syft catalogerSyftCatalogerOptions
syft cataloger listSyftCatalogerListOptions
syft configSyftConfigOptions
syft config locationsSyftConfigLocationsOptions
syft convertSyftConvertOptions
syft loginSyftLoginOptions
syft scanSyftScanOptions