cli

Documentation

Index

• type App
  • func New(args []string) *App
  • func (c *App) Parse() error
  • func (c *App) PrintUsage()
  • func (c App) String() string
  • func (c App) Validate() error
• type HostInput
  • func (h HostInput) Address() string
  • func (h *HostInput) Set(value string) error
  • func (h HostInput) String() string

Types

type App

type App struct {
	Command      string
	Local        HostInput
	Remote       HostInput
	Server       HostInput
	Key          string
	Verbose      bool
	Help         bool
	Version      bool
	Alias        string
	Start        string
	AliasDelete  bool
	Detach       bool
	Stop         string
	AliasList    bool
	InsecureMode bool
	// contains filtered or unexported fields
}

App contains main settings of application.

func New

func New(args []string) *App

New creates a new instance of App.

func (*App) Parse

func (c *App) Parse() error

Parse grabs arguments and flags from CLI.

func (*App) PrintUsage

func (c *App) PrintUsage()

PrintUsage prints, to the standard output, the informational text on how to use the tool.

func (App) String

func (c App) String() string

String returns a string representation of an App.

func (App) Validate

func (c App) Validate() error

Validate checks parsed params.

type HostInput

type HostInput struct {
	User string
	Host string
	Port string
}

HostInput holds information about a host

func (HostInput) Address

func (h HostInput) Address() string

Address returns a string representation of HostInput to be used to perform network connections.

func (*HostInput) Set

func (h *HostInput) Set(value string) error

Set parses a string representation of HostInput into its proper attributes.

func (HostInput) String

func (h HostInput) String() string

String returns a string representation of a HostInput