version

Documentation

Index

• Variables
• func GetParent(c interface{}) *cobra.Command
• type VersionFunc
• type VersionInfo
  • func (v *VersionInfo) Display() error
• type VersionSubCommand
  • func NewBaseVersionSubCommand(parentCommand *cobra.Command) *VersionSubCommand
  • func (v *VersionSubCommand) Setup()

Variables

var CLIVersion = "dev"

Functions

func GetParent

func GetParent(c interface{}) *cobra.Command

GetParent is a convenience function written when the CLI code is scaffolded to return the parent command and avoid scaffolding code with bad imports.

Types

type VersionFunc

type VersionFunc func(*VersionSubCommand) error

type VersionInfo

type VersionInfo struct {
	CLIVersion  string   `json:"cliVersion"`
	APIVersions []string `json:"apiVersions"`
}

func (*VersionInfo) Display

func (v *VersionInfo) Display() error

Display will parse and print the information stored on the VersionInfo object.

type VersionSubCommand

type VersionSubCommand struct {
	*cobra.Command

	// options
	Name         string
	Description  string
	SubCommandOf *cobra.Command

	VersionFunc VersionFunc
}

func NewBaseVersionSubCommand

func NewBaseVersionSubCommand(parentCommand *cobra.Command) *VersionSubCommand

NewBaseVersionSubCommand returns a subcommand that is meant to belong to a parent subcommand but have subcommands itself.

func (*VersionSubCommand) Setup

func (v *VersionSubCommand) Setup()

Setup sets up this command to be used as a command.