about

Documentation

Index

• Variables
• type AboutCommand
  • func NewAboutCommand() *AboutCommand
  • func (cmd *AboutCommand) AddOptions(set shell.CmdSet)
  • func (cmd *AboutCommand) Execute(args []string) error
• type AuthTopic
  • func NewAuthTopic() *AuthTopic
  • func (a *AuthTopic) GetDescription() string
  • func (a *AuthTopic) GetKey() string
  • func (a *AuthTopic) GetTitle() string
  • func (a *AuthTopic) WriteAbout(o io.Writer) error
• type BenchmarkTopic
  • func NewBenchmarkTopic() *BenchmarkTopic
  • func (a *BenchmarkTopic) GetDescription() string
  • func (a *BenchmarkTopic) GetKey() string
  • func (a *BenchmarkTopic) GetTitle() string
  • func (a *BenchmarkTopic) WriteAbout(o io.Writer) error
• type JsonPathTopic
  • func NewJsonPathTopic() *JsonPathTopic
  • func (a *JsonPathTopic) GetDescription() string
  • func (a *JsonPathTopic) GetKey() string
  • func (a *JsonPathTopic) GetTitle() string
  • func (a *JsonPathTopic) WriteAbout(o io.Writer) error
• type SubstitutionTopic
  • func NewSubstitutionTopic() *SubstitutionTopic
  • func (a *SubstitutionTopic) GetDescription() string
  • func (a *SubstitutionTopic) GetKey() string
  • func (a *SubstitutionTopic) GetTitle() string
  • func (a *SubstitutionTopic) WriteAbout(o io.Writer) error
  • func (a *SubstitutionTopic) WriteSubTopic(o io.Writer, fname string) error
• type VersionCommand
  • func NewVersionCommand() *VersionCommand
  • func (cmd *VersionCommand) AddOptions(set shell.CmdSet)
  • func (cmd *VersionCommand) Execute(args []string) error

Variables

var BuildBranch string

var BuildCommit string

var BuildVersion string

Types

type AboutCommand

type AboutCommand struct {
}

func NewAboutCommand

func NewAboutCommand() *AboutCommand

func (*AboutCommand) AddOptions

func (cmd *AboutCommand) AddOptions(set shell.CmdSet)

func (*AboutCommand) Execute

func (cmd *AboutCommand) Execute(args []string) error

Execute -- Execute the command About command

type AuthTopic

type AuthTopic struct {
	Key         string
	Title       string
	Description string
	About       string
}

func NewAuthTopic

func NewAuthTopic() *AuthTopic

func (*AuthTopic) GetDescription

func (a *AuthTopic) GetDescription() string

func (*AuthTopic) GetKey

func (a *AuthTopic) GetKey() string

func (*AuthTopic) GetTitle

func (a *AuthTopic) GetTitle() string

func (*AuthTopic) WriteAbout

func (a *AuthTopic) WriteAbout(o io.Writer) error

type BenchmarkTopic

type BenchmarkTopic struct {
	Key         string
	Title       string
	Description string
	About       string
}

func NewBenchmarkTopic

func NewBenchmarkTopic() *BenchmarkTopic

func (*BenchmarkTopic) GetDescription

func (a *BenchmarkTopic) GetDescription() string

func (*BenchmarkTopic) GetKey

func (a *BenchmarkTopic) GetKey() string

func (*BenchmarkTopic) GetTitle

func (a *BenchmarkTopic) GetTitle() string

func (*BenchmarkTopic) WriteAbout

func (a *BenchmarkTopic) WriteAbout(o io.Writer) error

type JsonPathTopic

type JsonPathTopic struct {
	Key         string
	Title       string
	Description string
	About       string
}

func NewJsonPathTopic

func NewJsonPathTopic() *JsonPathTopic

func (*JsonPathTopic) GetDescription

func (a *JsonPathTopic) GetDescription() string

func (*JsonPathTopic) GetKey

func (a *JsonPathTopic) GetKey() string

func (*JsonPathTopic) GetTitle

func (a *JsonPathTopic) GetTitle() string

func (*JsonPathTopic) WriteAbout

func (a *JsonPathTopic) WriteAbout(o io.Writer) error

type SubstitutionTopic

type SubstitutionTopic struct {
	Key         string
	Title       string
	Description string
	About       string
}

func NewSubstitutionTopic

func NewSubstitutionTopic() *SubstitutionTopic

NewSubstitutionTopic -- return a topic structure for help about Substitutions

func (*SubstitutionTopic) GetDescription

func (a *SubstitutionTopic) GetDescription() string

GetDescription -- return the description of substitution about topic

func (*SubstitutionTopic) GetKey

func (a *SubstitutionTopic) GetKey() string

GetKey -- return the key to the substitution help topic

func (*SubstitutionTopic) GetTitle

func (a *SubstitutionTopic) GetTitle() string

GetTitle() -- return the title of the substitution about topic

func (*SubstitutionTopic) WriteAbout

func (a *SubstitutionTopic) WriteAbout(o io.Writer) error

WriteAbout -- write the substitution about topic to the provided writer

func (*SubstitutionTopic) WriteSubTopic

func (a *SubstitutionTopic) WriteSubTopic(o io.Writer, fname string) error

WriteSubTopic -- Write the Subtopic about information

type VersionCommand

type VersionCommand struct {
	Branch  string
	Commit  string
	Version string
}

func NewVersionCommand

func NewVersionCommand() *VersionCommand

func (*VersionCommand) AddOptions

func (cmd *VersionCommand) AddOptions(set shell.CmdSet)

func (*VersionCommand) Execute

func (cmd *VersionCommand) Execute(args []string) error