analyse

Documentation

Index

• Constants
• Variables
• func Init(cfg *config.Config)
• type RunOptionsAnalyse

Constants

const (
	ModeSinglePath = "single-path"
	ModeInputFile  = "input-file"
)

Mode constants

Variables

var AnalyseCmd = &cobra.Command{
	Use:                   "analyse --scanner/-p PLUGIN_NAME [--config/-c PATH] [--format/-f OUTPUT_FORMAT] [-j THREADS_NUMBER, default=1] {--input-file/-i PATH | PATH} -- [args...]",
	SilenceUsage:          true,
	DisableFlagsInUseLine: true,
	Example:               exampleAnalyseUsage,
	Short:                 "Provides a top-level interface with orchestration for running a specified scanner",
	RunE:                  runAnalyseCommand,
}

AnalyseCmd represents the analyse command.

var (
	AppConfig *config.Config
)

Global variables for configuration and command arguments

Functions

func Init

func Init(cfg *config.Config)

Init initializes the global configuration variable.

Types

type RunOptionsAnalyse

type RunOptionsAnalyse struct {
	Scanner        string   `json:"scanner,omitempty"`
	InputFile      string   `json:"input_file,omitempty"`
	ReportFormat   string   `json:"report_format,omitempty"`
	ScannerConfig  string   `json:"scanner_config,omitempty"`
	AdditionalArgs []string `json:"additional_args,omitempty"`
	OutputPath     string   `json:"output_path,omitempty"`
	Threads        int      `json:"threads"`
}

RunOptionsAnalyse holds the arguments for the analyse command.