flags

Documentation

Index

• Variables
• func Short(name string) string
• func ShortUpper(name string) string
• func WithAPIFlags(f []cli.Flag) []cli.Flag
• func WithGlobalFlags(f []cli.Flag) []cli.Flag
• func WithModulesFlags(f []cli.Flag) []cli.Flag
• func WithReportTemplateFlags(f []cli.Flag) []cli.Flag

Variables

var (
	API       = []cli.Flag{EndpointF, TitleF, FetcherF, ProjectF, RevisionF, BranchF}
	Endpoint  = "endpoint"
	EndpointF = cli.StringFlag{Name: Short(Endpoint), Usage: "the FOSSA server endpoint (default: 'https://app.fossa.io')"}
	Title     = "title"
	TitleF    = cli.StringFlag{Name: Short(Title), Usage: "the title of the FOSSA project. (default: the project name)"}
	Fetcher   = "fetcher"
	FetcherF  = cli.StringFlag{Name: Short(Fetcher), Usage: "type of fetcher to use for fossa. (default: 'custom')"}
	Project   = "project"
	ProjectF  = cli.StringFlag{Name: Short(Project), Usage: "this repository's URL or VCS endpoint (default: VCS remote 'origin')"}
	Revision  = "revision"
	RevisionF = cli.StringFlag{Name: Short(Revision), Usage: "this repository's current revision hash (default: VCS hash HEAD)"}
	Branch    = "branch"
	BranchF   = cli.StringFlag{Name: Short(Branch), Usage: "this repository's current branch (default: current VCS branch)"}
)

var (
	Global  = []cli.Flag{ConfigF, NoAnsiF, DebugF}
	Config  = "config"
	ConfigF = cli.StringFlag{Name: Short(Config), Usage: "path to config file (default: '.fossa.{yml,yaml}')"}
	NoAnsi  = "no-ansi"
	NoAnsiF = cli.BoolFlag{Name: NoAnsi, Usage: "do not use interactive mode (ANSI codes)"}
	Debug   = "debug"
	DebugF  = cli.BoolFlag{Name: Debug, Usage: "print debug information to stderr"}
)

var (
	Modules = []cli.Flag{OptionF}
	Option  = "option"
	OptionF = cli.StringSliceFlag{Name: Option, Usage: "options for the module (format is `key:value` e.g. allow-unresolved:true)"}
)

var (
	ReportCmd   = []cli.Flag{OutputFileF, TemplateF}
	OutputFile  = "output-file"
	OutputFileF = cli.StringFlag{Name: OutputFile, Value: "-", Usage: "Output file for report"}
	Template    = "template"
	TemplateF   = cli.StringFlag{Name: Template, Usage: "process result via template file prior to sending it to output"}
)

Functions

func Short

func Short(name string) string

func ShortUpper

func ShortUpper(name string) string

func WithAPIFlags

func WithAPIFlags(f []cli.Flag) []cli.Flag

func WithGlobalFlags

func WithGlobalFlags(f []cli.Flag) []cli.Flag

func WithModulesFlags

func WithModulesFlags(f []cli.Flag) []cli.Flag

func WithReportTemplateFlags

func WithReportTemplateFlags(f []cli.Flag) []cli.Flag