flags

Documentation

Index

• Constants
• func BindFlags(cmd *cobra.Command, v *viper.Viper) error
• func FormatNewError(flag1, flag2 string) error
• func GetAllFlags() map[string]interface{}
• func GetBoolFlag(flagName string) bool
• func GetIntFlag(flagName string) int
• func GetMultiStrFlag(flagName string) []string
• func GetStrFlag(flagName string) string
• func InitJSONFlags(cmd *cobra.Command, flagsListContent string, persistentFlag bool, ...) error
• func SetMultiStrFlag(flagName string, value []string)
• func SetStrFlag(flagName, value string)
• func Validate() error
• func ValidateQuerySelectionFlags() error
• func ValidateTypeSelectionFlags() error

Constants

const (
	AnalyzeResults = "analyze-results"
	AnalyzePath    = "analyze-path"
)

Flags constants for analyze

const (
	CIFlag             = "ci"
	LogFileFlag        = "log-file"
	LogFileShorthand   = "l"
	LogFormatFlag      = "log-format"
	LogFormatShorthand = "f"
	LogLevelFlag       = "log-level"
	LogPathFlag        = "log-path"
	NoColorFlag        = "no-color"
	ProfilingFlag      = "profiling"
	SilentFlag         = "silent"
	SilentShorthand    = "s"
	VerboseFlag        = "verbose"
	VerboseShorthand   = "v"
)

Flags constants for kics

const (
	Results    = "results"
	IncludeIds = "include-ids"
)

Flags constants for remediate

const (
	BomFlag                 = "bom"
	CloudProviderFlag       = "cloud-provider"
	ConfigFlag              = "config"
	DisableFullDescFlag     = "disable-full-descriptions"
	ExcludeCategoriesFlag   = "exclude-categories"
	ExcludePathsFlag        = "exclude-paths"
	ExcludeQueriesFlag      = "exclude-queries"
	ExcludeResultsFlag      = "exclude-results"
	ExcludeSeveritiesFlag   = "exclude-severities"
	ExperimentalQueriesFlag = "experimental-queries"
	IncludeQueriesFlag      = "include-queries"
	InputDataFlag           = "input-data"
	FailOnFlag              = "fail-on"
	IgnoreOnExitFlag        = "ignore-on-exit"
	MinimalUIFlag           = "minimal-ui"
	NoProgressFlag          = "no-progress"
	OutputNameFlag          = "output-name"
	OutputPathFlag          = "output-path"
	PathFlag                = "path"
	PayloadPathFlag         = "payload-path"
	PreviewLinesFlag        = "preview-lines"
	QueriesPath             = "queries-path"
	LibrariesPath           = "libraries-path"
	ReportFormatsFlag       = "report-formats"
	TypeFlag                = "type"
	ExcludeTypeFlag         = "exclude-type"
	TerraformVarsPathFlag   = "terraform-vars-path"
	QueryExecTimeoutFlag    = "timeout"
	LineInfoPayloadFlag     = "payload-lines"
	DisableSecretsFlag      = "disable-secrets"
	SecretsRegexesPathFlag  = "secrets-regexes-path" //nolint:gosec
	ExcludeGitIgnore        = "exclude-gitignore"
	OpenAPIReferencesFlag   = "enable-openapi-refs"
	ParallelScanFile        = "parallel"
	MaxFileSizeFlag         = "max-file-size"
)

Flags constants for scan

Functions

func BindFlags

func BindFlags(cmd *cobra.Command, v *viper.Viper) error

BindFlags fill flags values with config file or environment variables data

func FormatNewError

func FormatNewError(flag1, flag2 string) error

FormatNewError reports the impossibility of flag1 and flag2 usage simultaneously

func GetAllFlags

func GetAllFlags() map[string]interface{}

GetAllFlags returns all flags values

func GetBoolFlag

func GetBoolFlag(flagName string) bool

GetBoolFlag get a boolean flag by its name

func GetIntFlag

func GetIntFlag(flagName string) int

GetIntFlag get a integer flag by its name

func GetMultiStrFlag

func GetMultiStrFlag(flagName string) []string

GetMultiStrFlag get a slice of strings flag by its name

func GetStrFlag

func GetStrFlag(flagName string) string

GetStrFlag get a string flag by its name

func InitJSONFlags

func InitJSONFlags(
	cmd *cobra.Command,
	flagsListContent string,
	persistentFlag bool,
	supportedPlatforms,
	supportedCloudProviders []string) error

InitJSONFlags initialize cobra flags

func SetMultiStrFlag

func SetMultiStrFlag(flagName string, value []string)

SetMultiStrFlag set a slice of strings flag using its name

func SetStrFlag

func SetStrFlag(flagName, value string)

SetStrFlag set a string flag using its name

func Validate

func Validate() error

Validate validate if flag values are ok, if not, returns an error

func ValidateQuerySelectionFlags

func ValidateQuerySelectionFlags() error

ValidateQuerySelectionFlags reports the impossibility of include and exclude flags usage simultaneously

func ValidateTypeSelectionFlags

func ValidateTypeSelectionFlags() error

ValidateTypeSelectionFlags reports the impossibility of include and exclude flags usage simultaneously