cli

Documentation

Overview

Package cli defines the structures to store the CLI flags used by the scanner binary.

Index

• func ValidateFlags(flags *Flags) error
• type Array
  • func (i *Array) Get() any
  • func (i *Array) Set(value string) error
  • func (i *Array) String() string
• type Flags
  • func (f *Flags) GetCDXConfig() converter.CDXConfig
  • func (f *Flags) GetSPDXConfig() converter.SPDXConfig
  • func (f *Flags) GetScanConfig() (*scalibr.ScanConfig, error)
  • func (f *Flags) WriteScanResults(result *scalibr.ScanResult) error
• type StringListFlag
  • func NewStringListFlag(defaultValue []string) StringListFlag
  • func (s *StringListFlag) Get() any
  • func (s *StringListFlag) GetSlice() []string
  • func (s *StringListFlag) Reset()
  • func (s *StringListFlag) Set(x string) error
  • func (s *StringListFlag) String() string

Functions

func ValidateFlags

func ValidateFlags(flags *Flags) error

ValidateFlags validates the passed command line flags.

Types

type Array

type Array []string

Array is a type to be passed to flag.Var that supports arrays passed as repeated flags, e.g. ./scalibr -o binproto=out.bp -o spdx23-json=out.spdx.json

func (*Array) Get

func (i *Array) Get() any

Get returns the underlying []string value stored by this flag struct.

func (*Array) Set

func (i *Array) Set(value string) error

Set gets called whenever a new instance of a flag is read during CLI arg parsing. For example, in the case of -o foo -o bar the library will call arr.Set("foo") then arr.Set("bar").

func (*Array) String

func (i *Array) String() string

type Flags

type Flags struct {
	Root                  string
	ResultFile            string
	Output                Array
	ExtractorsToRun       []string
	DetectorsToRun        []string
	FilesToExtract        []string
	DirsToSkip            []string
	SkipDirRegex          string
	SkipDirGlob           string
	RemoteImage           string
	ImagePlatform         string
	GovulncheckDBPath     string
	SPDXDocumentName      string
	SPDXDocumentNamespace string
	SPDXCreators          string
	CDXComponentName      string
	CDXComponentVersion   string
	CDXAuthors            string
	Verbose               bool
	ExplicitExtractors    bool
	FilterByCapabilities  bool
	StoreAbsolutePath     bool
	WindowsAllDrives      bool
	Offline               bool
}

Flags contains a field for all the cli flags that can be set.

func (*Flags) GetCDXConfig

func (f *Flags) GetCDXConfig() converter.CDXConfig

GetCDXConfig creates an CDXConfig struct based on the CLI flags.

func (*Flags) GetSPDXConfig

func (f *Flags) GetSPDXConfig() converter.SPDXConfig

GetSPDXConfig creates an SPDXConfig struct based on the CLI flags.

func (*Flags) GetScanConfig

func (f *Flags) GetScanConfig() (*scalibr.ScanConfig, error)

GetScanConfig constructs a SCALIBR scan config from the provided CLI flags.

func (*Flags) WriteScanResults

func (f *Flags) WriteScanResults(result *scalibr.ScanResult) error

WriteScanResults writes SCALIBR scan results to files specified by the CLI flags.

type StringListFlag

type StringListFlag struct {
	// contains filtered or unexported fields
}

StringListFlag is a type to be passed to flag.Var that supports list flags passed as repeated flags, e.g. ./scalibr -o a -o b,c the library will call arr.Set("a") then arr.Set("a,b").

func NewStringListFlag

func NewStringListFlag(defaultValue []string) StringListFlag

NewStringListFlag creates a new StringListFlag with the given default value.

func (*StringListFlag) Get

func (s *StringListFlag) Get() any

Get returns the underlying []string value stored by this flag struct.

func (*StringListFlag) GetSlice

func (s *StringListFlag) GetSlice() []string

GetSlice returns the underlying []string value stored by this flag struct.

func (*StringListFlag) Reset

func (s *StringListFlag) Reset()

Reset resets the flag to its default value.

func (*StringListFlag) Set

func (s *StringListFlag) Set(x string) error

Set gets called whenever a new instance of a flag is read during CLI arg parsing. For example, in the case of -o foo -o bar the library will call arr.Set("foo") then arr.Set("bar").

func (*StringListFlag) String

func (s *StringListFlag) String() string