Skip to main content

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;

Global options​

Global options are rendered before the selected subcommand.

CLI optionPropertyAvailabilityDescription
--configConfigAll editionssyft configuration file(s) to use
--profileProfileAll editionsconfiguration profiles to use
--quietQuietAll editionssuppress all logging output
--verboseVerboseAll editionsincrease verbosity (-v = info, -vv = debug)

Commands​

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