cli

type ConfigDir ¶ added in v0.2.0

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

ConfigDir allows managing a multiple contextual configuration files. Each configuration is given a context name, e.g. `prod`, `staging`, `devel` and each stores a specific configuration.

func NewConfigDir(path string, opts ...ConfigDirOption) (*ConfigDir, error)

func (c *ConfigDir) Current(as interface{}) (*configInfo, error)

func (c *ConfigDir) Get(name string, as interface{}) error

func (c *ConfigDir) List() ([]string, error)

func (c *ConfigDir) Set(name string, from interface{}) error

func (c *ConfigDir) Use(name string) error

type ConfigDirCli ¶ added in v0.2.0

type ConfigDirCli struct {
	ConfigDirFlag
	Config ConfigDirCmd `cmd:"config"`
	// contains filtered or unexported fields
}

func (c *ConfigDirCli) Get(cfg interface{}) error

func (c *ConfigDirCli) KongInit(path string, options ...ConfigDirOption) kong.Option

func (c *ConfigDirCli) Set(cfg interface{}, setCurrent bool) error

type ConfigDirCmd ¶ added in v0.2.0

type ConfigDirCmd struct {
	Use  ConfigUseCmd  `cmd:"use"`
	List ConfigListCmd `cmd:"list"`
}

func (u *ConfigDirCmd) BeforeResolve(c *ConfigDirCli) (err error)

func (u *ConfigDirCmd) Help() string

type ConfigDirFlag ¶ added in v0.2.0

type ConfigDirFlag struct {
	Config string `opt:""`
}

func (f *ConfigDirFlag) BeforeResolve(c *ConfigDirCli) (err error)

func (f *ConfigDirFlag) Help() string

type ConfigDirOption ¶ added in v0.2.0

type ConfigDirOption interface {
	// contains filtered or unexported methods
}

func WithConfigDirLoader(loader ConfigLoader) ConfigDirOption

func WithXdgConfigPath(configPath string) ConfigDirOption

type ConfigListCmd ¶ added in v0.2.0

type ConfigListCmd struct {
}

func (u *ConfigListCmd) BeforeResolve(c *ConfigDirCli) (err error)

func (u *ConfigListCmd) Run(c *ConfigDirCli) error

type ConfigLoader ¶ added in v0.2.0

type ConfigLoader interface {
	Unmarshal([]byte, interface{}) error
	Marshal(interface{}) ([]byte, error)
}

type ConfigUseCmd ¶ added in v0.2.0

type ConfigUseCmd struct {
	Name string `arg:"" placeholder:"<name>"`
}

func (u *ConfigUseCmd) BeforeResolve(c *ConfigDirCli) (err error)

func (u *ConfigUseCmd) Run(c *ConfigDirCli) error

type ProfilingFlag ¶ added in v0.2.0

type ProfilingFlag struct {
	Profiling string `opt:"" hidden:"true" default:""`
}

Profiling is a struct that can be embedded in any kong cli to enable easy and convenient profiling for performance analysis. The flag is hidden from the help message such that we can use it in public cli.

The supported values are:

• "cpu": Enables CPU profiling.
• "memory": Enables heap memory profiling.
• "block": Enables block (contention) profiling.
• "mutex": Enables mutex profiling.
• "trace": Enables trace profiling.

The profiling file path will be shown to stderr and can be opened with `go tool pprof $file` or `go tool pprof -http localhost:8080 $file`

In order to enable profiling, one should use the command like this: ``` stopProfiling := cli.Profiling.Start() defer stopProfiling() ```

func (p *ProfilingFlag) Start() func()