libcmdline

Documentation

Index

• type CmdBaseHelp
  • func (c *CmdBaseHelp) GetUsage() libkb.Usage
  • func (c *CmdBaseHelp) ParseArgv(*cli.Context) error
  • func (c *CmdBaseHelp) Run() error
  • func (c *CmdBaseHelp) RunClient() error
• type CmdGeneralHelp
• type CmdSpecificHelp
  • func (c CmdSpecificHelp) Run() error
• type Command
• type CommandLine
  • func NewCommandLine(addHelp bool, extraFlags []cli.Flag) *CommandLine
  • func (p *CommandLine) AddCommands(cmds []cli.Command)
  • func (p *CommandLine) AddHelpTopics(topics []cli.HelpTopic)
  • func (p *CommandLine) ChooseCommand(cmd Command, name string, ctx *cli.Context)
  • func (p CommandLine) GetAPIDump() (bool, bool)
  • func (p CommandLine) GetAPITimeout() (time.Duration, bool)
  • func (p CommandLine) GetAutoFork() (bool, bool)
  • func (p CommandLine) GetBool(s string, glbl bool) (bool, bool)
  • func (p CommandLine) GetConfigFilename() string
  • func (p CommandLine) GetDbFilename() string
  • func (p CommandLine) GetDebug() (bool, bool)
  • func (p CommandLine) GetForkCmd() ForkCmd
  • func (p CommandLine) GetGDuration(s string) (time.Duration, error)
  • func (p CommandLine) GetGInt(s string) int
  • func (p CommandLine) GetGString(s string) string
  • func (p CommandLine) GetGpg() string
  • func (p CommandLine) GetGpgHome() string
  • func (p CommandLine) GetGpgOptions() []string
  • func (p CommandLine) GetHome() string
  • func (p CommandLine) GetLocalRPCDebug() string
  • func (p CommandLine) GetLogFile() string
  • func (p CommandLine) GetLogFormat() string
  • func (p *CommandLine) GetLogForward() LogForward
  • func (p CommandLine) GetMerkleKIDs() []string
  • func (p CommandLine) GetNoAutoFork() (bool, bool)
  • func (p CommandLine) GetPGPFingerprint() *libkb.PGPFingerprint
  • func (p CommandLine) GetPidFile() string
  • func (p CommandLine) GetPinentry() string
  • func (p CommandLine) GetProofCacheSize() (int, bool)
  • func (p CommandLine) GetProxy() string
  • func (p CommandLine) GetRunMode() (libkb.RunMode, error)
  • func (p CommandLine) GetScraperTimeout() (time.Duration, bool)
  • func (p CommandLine) GetSecretKeyringTemplate() string
  • func (p CommandLine) GetServerURI() string
  • func (p CommandLine) GetSessionFilename() string
  • func (p CommandLine) GetSocketFile() string
  • func (p CommandLine) GetSplitLogOutput() (bool, bool)
  • func (p CommandLine) GetStandalone() (bool, bool)
  • func (p CommandLine) GetString(s string) string
  • func (p CommandLine) GetTimers() string
  • func (p CommandLine) GetUserCacheMaxAge() (time.Duration, bool)
  • func (p CommandLine) IsNoStandalone() bool
  • func (p CommandLine) IsService() bool
  • func (p *CommandLine) Parse(args []string) (cmd Command, err error)
  • func (p *CommandLine) PopulateApp(addHelp bool, extraFlags []cli.Flag)
  • func (p *CommandLine) SetDefaultCommand(name string, cmd Command)
  • func (p *CommandLine) SetForkCmd(v ForkCmd)
  • func (p *CommandLine) SetLogForward(f LogForward)
  • func (p *CommandLine) SetNoStandalone()
  • func (p *CommandLine) SetOutputWriter(w io.Writer)
  • func (p *CommandLine) SetService()
• type ForkCmd
• type LogForward

Types

type CmdBaseHelp

type CmdBaseHelp struct {
	// contains filtered or unexported fields
}

func (*CmdBaseHelp) GetUsage

func (c *CmdBaseHelp) GetUsage() libkb.Usage

func (*CmdBaseHelp) ParseArgv

func (c *CmdBaseHelp) ParseArgv(*cli.Context) error

func (*CmdBaseHelp) Run

func (c *CmdBaseHelp) Run() error

func (*CmdBaseHelp) RunClient

func (c *CmdBaseHelp) RunClient() error

type CmdGeneralHelp

type CmdGeneralHelp struct {
	CmdBaseHelp
}

type CmdSpecificHelp

type CmdSpecificHelp struct {
	CmdBaseHelp
	// contains filtered or unexported fields
}

func (CmdSpecificHelp) Run

func (c CmdSpecificHelp) Run() error

type Command

type Command interface {
	libkb.Command
	ParseArgv(*cli.Context) error // A command-specific parse-args
	Run() error                   // Run in client mode
}

type CommandLine

type CommandLine struct {
	// contains filtered or unexported fields
}

func NewCommandLine

func NewCommandLine(addHelp bool, extraFlags []cli.Flag) *CommandLine

func (*CommandLine) AddCommands

func (p *CommandLine) AddCommands(cmds []cli.Command)

func (*CommandLine) AddHelpTopics

func (p *CommandLine) AddHelpTopics(topics []cli.HelpTopic)

AddHelpTopics appends topics to the list of help topics for this app.

func (*CommandLine) ChooseCommand

func (p *CommandLine) ChooseCommand(cmd Command, name string, ctx *cli.Context)

Called back from inside our subcommands, when they're picked...

func (CommandLine) GetAPIDump

func (p CommandLine) GetAPIDump() (bool, bool)

func (CommandLine) GetAPITimeout

func (p CommandLine) GetAPITimeout() (time.Duration, bool)

func (CommandLine) GetAutoFork

func (p CommandLine) GetAutoFork() (bool, bool)

func (CommandLine) GetBool

func (p CommandLine) GetBool(s string, glbl bool) (bool, bool)

func (CommandLine) GetConfigFilename

func (p CommandLine) GetConfigFilename() string

func (CommandLine) GetDbFilename

func (p CommandLine) GetDbFilename() string

func (CommandLine) GetDebug

func (p CommandLine) GetDebug() (bool, bool)

func (CommandLine) GetForkCmd

func (p CommandLine) GetForkCmd() ForkCmd

func (CommandLine) GetGDuration

func (p CommandLine) GetGDuration(s string) (time.Duration, error)

func (CommandLine) GetGInt

func (p CommandLine) GetGInt(s string) int

func (CommandLine) GetGString

func (p CommandLine) GetGString(s string) string

func (CommandLine) GetGpg

func (p CommandLine) GetGpg() string

func (CommandLine) GetGpgHome

func (p CommandLine) GetGpgHome() string

func (CommandLine) GetGpgOptions

func (p CommandLine) GetGpgOptions() []string

func (CommandLine) GetHome

func (p CommandLine) GetHome() string

func (CommandLine) GetLocalRPCDebug

func (p CommandLine) GetLocalRPCDebug() string

func (CommandLine) GetLogFile

func (p CommandLine) GetLogFile() string

func (CommandLine) GetLogFormat

func (p CommandLine) GetLogFormat() string

func (*CommandLine) GetLogForward

func (p *CommandLine) GetLogForward() LogForward

func (CommandLine) GetMerkleKIDs

func (p CommandLine) GetMerkleKIDs() []string

func (CommandLine) GetNoAutoFork

func (p CommandLine) GetNoAutoFork() (bool, bool)

func (CommandLine) GetPGPFingerprint

func (p CommandLine) GetPGPFingerprint() *libkb.PGPFingerprint

func (CommandLine) GetPidFile

func (p CommandLine) GetPidFile() string

func (CommandLine) GetPinentry

func (p CommandLine) GetPinentry() string

func (CommandLine) GetProofCacheSize

func (p CommandLine) GetProofCacheSize() (int, bool)

func (CommandLine) GetProxy

func (p CommandLine) GetProxy() string

func (CommandLine) GetRunMode

func (p CommandLine) GetRunMode() (libkb.RunMode, error)

func (CommandLine) GetScraperTimeout

func (p CommandLine) GetScraperTimeout() (time.Duration, bool)

func (CommandLine) GetSecretKeyringTemplate

func (p CommandLine) GetSecretKeyringTemplate() string

func (CommandLine) GetServerURI

func (p CommandLine) GetServerURI() string

func (CommandLine) GetSessionFilename

func (p CommandLine) GetSessionFilename() string

func (CommandLine) GetSocketFile

func (p CommandLine) GetSocketFile() string

func (CommandLine) GetSplitLogOutput

func (p CommandLine) GetSplitLogOutput() (bool, bool)

func (CommandLine) GetStandalone

func (p CommandLine) GetStandalone() (bool, bool)

func (CommandLine) GetString

func (p CommandLine) GetString(s string) string

func (CommandLine) GetTimers

func (p CommandLine) GetTimers() string

func (CommandLine) GetUserCacheMaxAge

func (p CommandLine) GetUserCacheMaxAge() (time.Duration, bool)

func (CommandLine) IsNoStandalone

func (p CommandLine) IsNoStandalone() bool

func (CommandLine) IsService

func (p CommandLine) IsService() bool

func (*CommandLine) Parse

func (p *CommandLine) Parse(args []string) (cmd Command, err error)

func (*CommandLine) PopulateApp

func (p *CommandLine) PopulateApp(addHelp bool, extraFlags []cli.Flag)

func (*CommandLine) SetDefaultCommand

func (p *CommandLine) SetDefaultCommand(name string, cmd Command)

func (*CommandLine) SetForkCmd

func (p *CommandLine) SetForkCmd(v ForkCmd)

func (*CommandLine) SetLogForward

func (p *CommandLine) SetLogForward(f LogForward)

func (*CommandLine) SetNoStandalone

func (p *CommandLine) SetNoStandalone()

func (*CommandLine) SetOutputWriter

func (p *CommandLine) SetOutputWriter(w io.Writer)

func (*CommandLine) SetService

func (p *CommandLine) SetService()

type ForkCmd

type ForkCmd int

const (
	NormalFork ForkCmd = iota
	NoFork
	ForceFork
)

type LogForward

type LogForward int

const (
	LogForwardNormal LogForward = iota
	LogForwardNone
)