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. Projects using C# 13 or another .NET language can use context.Tools.Get<ModularPipelines.Syft.Services.ISyft>() 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 syft = context.Tools.Syft;

Commands

CLI command	Options record
syft attest	SyftAttestOptions
syft cataloger	SyftCatalogerOptions
syft cataloger list	SyftCatalogerListOptions
syft config	SyftConfigOptions
syft config locations	SyftConfigLocationsOptions
syft convert	SyftConvertOptions
syft login	SyftLoginOptions
syft scan	SyftScanOptions