cli

Documentation

Index

• Constants
• func CheckBenchmarkInitFatal(err error)
• func CheckFatal(err error)
• func CheckUserArgFatal(err error)
• func CreateConfig(cmd *cobra.Command, args []string)
• func CreateConfigCommand() *cobra.Command
• func CreateUpdateCommand(version, binaryName string) *cobra.Command
• func GetBool(cmd *cobra.Command, name string) bool
• func GetString(cmd *cobra.Command, name string) string
• func GetStringSlice(cmd *cobra.Command, name string) []string
• func NewRootCommand(programName, version, build string) *cobra.Command
• func QuestionYN(prompt string) bool
• func RequestCommand(description string, required bool) *api.CommandSpec
• func RequestCommandLine(prompt string, required bool) []string
• func RequestEnvVars() map[string]string
• func RequestInput(prompt string, required bool, isValidFn IsValidFn) string
• func RequestOptionalBool(prompt string, defaultVal bool) bool
• func RequestOptionalExistingDirectory(prompt string, defaultVal string) string
• func RequestScenario() *api.ScenarioSpec
• func RequestScenarios() []*api.ScenarioSpec
• func RequestString(prompt string, required bool) string
• func RequestUint(prompt string, required bool) uint
• func ResolveOutputArg(cmd *cobra.Command, name string) io.WriteCloser
• func Run(cmd *cobra.Command, args []string)
• func RunSelfUpdateFor(version, binaryName string) func(cmd *cobra.Command, args []string)
• type CheckFatalFn
• type GetLatestReleaseFn
• type IsValidFn
• type ResolveBinaryPathFn

Constants

const (
	// ArgNameConfig : program arg name
	ArgNameConfig = "config"
	// ArgNameOutputFile : program arg name
	ArgNameOutputFile = "out-file"
	// ArgNameFormat : program arg name
	ArgNameFormat = "format"
	// ArgNamePipeStdout : program arg name
	ArgNamePipeStdout = "pipe-stdout"
	// ArgNamePipeStderr : program arg name
	ArgNamePipeStderr = "pipe-stderr"
	// ArgNameDebug : program arg name
	ArgNameDebug = "debug"
	// ArgNameSilent : program arg name
	ArgNameSilent = "silent"
	// ArgNameLabel : program arg name
	ArgNameLabel = "label"
	// ArgNameHeaders : program arg name
	ArgNameHeaders = "headers"

	// ArgValueReportFormatTxt : Plain text report format arg value
	ArgValueReportFormatTxt = "txt"
	// ArgValueReportFormatCsv : CSV report format arg value
	ArgValueReportFormatCsv = "csv"
	// ArgValueReportFormatCsvRaw : CSV raw data report format value
	ArgValueReportFormatCsvRaw = "csv/raw"
	// ArgValueReportFormatMarkdown : Markdown report format arg value
	ArgValueReportFormatMarkdown = "md"
	// ArgValueReportFormatMarkdownRaw : Markdown report format arg value
	ArgValueReportFormatMarkdownRaw = "md/raw"
)

Functions

func CheckBenchmarkInitFatal

func CheckBenchmarkInitFatal(err error)

func CheckFatal

func CheckFatal(err error)

func CheckUserArgFatal

func CheckUserArgFatal(err error)

func CreateConfig

func CreateConfig(cmd *cobra.Command, args []string)

func CreateConfigCommand

func CreateConfigCommand() *cobra.Command

CreateConfigCommand creates the 'config' sub command

func CreateUpdateCommand

func CreateUpdateCommand(version, binaryName string) *cobra.Command

CreateConfigCommand creates the 'config' sub command

func GetBool

func GetBool(cmd *cobra.Command, name string) bool

func GetString

func GetString(cmd *cobra.Command, name string) string

func GetStringSlice

func GetStringSlice(cmd *cobra.Command, name string) []string

func NewRootCommand

func NewRootCommand(programName, version, build string) *cobra.Command

func QuestionYN

func QuestionYN(prompt string) bool

func RequestCommand

func RequestCommand(description string, required bool) *api.CommandSpec

func RequestCommandLine

func RequestCommandLine(prompt string, required bool) []string

func RequestEnvVars

func RequestEnvVars() map[string]string

func RequestInput

func RequestInput(prompt string, required bool, isValidFn IsValidFn) string

func RequestOptionalBool

func RequestOptionalBool(prompt string, defaultVal bool) bool

func RequestOptionalExistingDirectory

func RequestOptionalExistingDirectory(prompt string, defaultVal string) string

func RequestScenario

func RequestScenario() *api.ScenarioSpec

func RequestScenarios

func RequestScenarios() []*api.ScenarioSpec

func RequestString

func RequestString(prompt string, required bool) string

func RequestUint

func RequestUint(prompt string, required bool) uint

func ResolveOutputArg

func ResolveOutputArg(cmd *cobra.Command, name string) io.WriteCloser

ResolveOutputArg resolves an output file argument based on user input. If the specified argument is empty, stdout is returned.

func Run

func Run(cmd *cobra.Command, args []string)

Run parses CLI arguments and runs the benchmark process

func RunSelfUpdateFor

func RunSelfUpdateFor(version, binaryName string) func(cmd *cobra.Command, args []string)

Types

type CheckFatalFn

type CheckFatalFn = func(error)

type GetLatestReleaseFn

type GetLatestReleaseFn = func() (github.Release, error)

type IsValidFn

type IsValidFn = func(string) bool

type ResolveBinaryPathFn

type ResolveBinaryPathFn = func() (string, error)