cmd

Documentation

Index

• Variables
• func Execute()
• func GetRootCommand() *cobra.Command
• type BoolFlagOpts
• type Command
  • func BuildCommand(parent *Command, fn RunFn, usageText string, shortHelpText string, ...) *Command
  • func BuildCommandKS(parent *Command, fn RunFn, keystrings docstrings.KeyStrings, out io.Writer, ...) *Command
  • func (c *Command) AddBoolFlag(options BoolFlagOpts)
  • func (c *Command) AddCommand(commands ...*Command)
  • func (c *Command) AddIntFlag(options IntFlagOpts)
  • func (c *Command) AddStringFlag(options StringFlagOpts)
  • func (c *Command) AddStringSliceFlag(options StringSliceFlagOpts)
• type Initializer
• type InitializerFn
• type IntFlagOpts
• type Option
• type RunFn
• type StringFlagOpts
• type StringSliceFlagOpts
• type TimingRequest
• type TimingResponse
• Bugs

Variables

var ErrAbort = errors.New("abort")

ErrAbort - Error generated when application aborts

Functions

func Execute

func Execute()

Execute - root command execution

func GetRootCommand

func GetRootCommand() *cobra.Command

GetRootCommand - root for commands

Types

type BoolFlagOpts

type BoolFlagOpts struct {
	Name        string
	Shorthand   string
	Description string
	Default     bool
	EnvName     string
	Hidden      bool
}

BoolFlagOpts - options for boolean flags

type Command

type Command struct {
	*cobra.Command
}

Command - Wrapper for a cobra command

func BuildCommand

func BuildCommand(parent *Command, fn RunFn, usageText string, shortHelpText string, longHelpText string, out io.Writer, options ...Option) *Command

BuildCommand - builds a functioning Command using all the initializers

func BuildCommandKS

func BuildCommandKS(parent *Command, fn RunFn, keystrings docstrings.KeyStrings, out io.Writer, options ...Option) *Command

BuildCommandKS - A wrapper for BuildCommand which takes the docs.KeyStrings bundle instead of the coder having to manually unwrap it

func (*Command) AddBoolFlag

func (c *Command) AddBoolFlag(options BoolFlagOpts)

AddBoolFlag - Add a boolean flag for a command

func (*Command) AddCommand

func (c *Command) AddCommand(commands ...*Command)

AddCommand adds subcommands to this command

func (*Command) AddIntFlag

func (c *Command) AddIntFlag(options IntFlagOpts)

AddIntFlag - Add an integer flag to a command

func (*Command) AddStringFlag

func (c *Command) AddStringFlag(options StringFlagOpts)

AddStringFlag - Add a string flag to a command

func (*Command) AddStringSliceFlag

func (c *Command) AddStringSliceFlag(options StringSliceFlagOpts)

AddStringSliceFlag - add a string slice flag to a command

type Initializer

type Initializer struct {
	Setup  InitializerFn
	PreRun InitializerFn
}

Initializer - Retains Setup and PreRun functions

type InitializerFn

type InitializerFn func(*cmdctx.CmdContext) error

InitializerFn - A wrapper for an Initializer function that takes a command context

type IntFlagOpts

type IntFlagOpts struct {
	Name        string
	Shorthand   string
	Description string
	Default     int
	EnvName     string
	Hidden      bool
}

IntFlagOpts - options for integer flags

type Option

type Option func(*Command) Initializer

Option - A wrapper for an Initializer function that takes a command

type RunFn

type RunFn func(cmdContext *cmdctx.CmdContext) error

RunFn - Run function for commands which takes a command context

type StringFlagOpts

type StringFlagOpts struct {
	Name        string
	Shorthand   string
	Description string
	Default     string
	EnvName     string
}

StringFlagOpts - options for string flags

type StringSliceFlagOpts

type StringSliceFlagOpts struct {
	Name        string
	Shorthand   string
	Description string
	Default     []string
	EnvName     string
}

StringSliceFlagOpts - options a string slice flag

type TimingRequest

type TimingRequest struct {
	URL    string `json:"url"`
	Region string `json:"region"`
}

TimingRequest - Request to time a curl operation

type TimingResponse

type TimingResponse struct {
	Err               error
	HTTPCode          int     `json:"http_code"`
	SpeedDownload     int     `json:"speed_download"`
	TimeTotal         float64 `json:"time_total"`
	TimeNameLookup    float64 `json:"time_namelookup"`
	TimeConnect       float64 `json:"time_connect"`
	TimePreTransfer   float64 `json:"time_pretransfer"`
	TimeAppConnect    float64 `json:"time_appconnect"`
	TimeStartTransfer float64 `json:"time_starttransfer"`
	HTTPVersion       string  `json:"http_version"`
	RemoteIP          string  `json:"remote_ip"`
	Scheme            string  `json:"scheme"`
	Region            string  `json:"region"`
}

TimingResponse - Results from timing a curl operations

Notes

Bugs

• can't stay this way