cli

Documentation

Overview

Copyright © 2021 Optable Technologies Inc. All rights reserved. See LICENSE for details.

Copyright © 2021 Optable Technologies Inc. All rights reserved. See LICENSE for details.

Copyright © 2021 Optable Technologies Inc. All rights reserved. See LICENSE for details.

Index

• Variables
• func LevelFromVerbosity(v int) zerolog.Level
• func NewLogger(cliName string, verbosity int) *zerolog.Logger
• type ConfigDir
  • 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
  • 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
  • func (u *ConfigDirCmd) BeforeResolve(c *ConfigDirCli) (err error)
  • func (u *ConfigDirCmd) Help() string
• type ConfigDirFlag
  • func (f *ConfigDirFlag) BeforeResolve(c *ConfigDirCli) (err error)
  • func (f *ConfigDirFlag) Help() string
• type ConfigDirOption
  • func WithConfigDirLoader(loader ConfigLoader) ConfigDirOption
  • func WithXdgConfigPath(configPath string) ConfigDirOption
• type ConfigListCmd
  • func (u *ConfigListCmd) BeforeResolve(c *ConfigDirCli) (err error)
  • func (u *ConfigListCmd) Run(c *ConfigDirCli) error
• type ConfigLoader
• type ConfigUseCmd
  • func (u *ConfigUseCmd) BeforeResolve(c *ConfigDirCli) (err error)
  • func (u *ConfigUseCmd) Run(c *ConfigDirCli) error
• type ProfilingFlag
  • func (p *ProfilingFlag) Start() func()

Variables

var JSONLoader = &jsonLoader{}

Functions

func LevelFromVerbosity

func LevelFromVerbosity(v int) zerolog.Level

LevelFromVerbosity takes a command-line `-v` stackable flag count, e.g. `-vv`, `-vvv` and transforms it into a sensible loglevel. The mapping is:

``:     Warn
`-v`:   Info
`-vv`:  Debug
`-vvv`: Trace

func NewLogger

func NewLogger(cliName string, verbosity int) *zerolog.Logger

Types

type ConfigDir

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

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

NewConfigDir creates a ConfigDir at a given path.

func (*ConfigDir) Current

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

func (*ConfigDir) Get

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

func (*ConfigDir) List

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

func (*ConfigDir) Set

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

func (*ConfigDir) Use

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

type ConfigDirCli

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

func (*ConfigDirCli) Get

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

func (*ConfigDirCli) KongInit

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

func (*ConfigDirCli) Set

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

type ConfigDirCmd

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

func (*ConfigDirCmd) BeforeResolve

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

func (*ConfigDirCmd) Help

func (u *ConfigDirCmd) Help() string

type ConfigDirFlag

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

func (*ConfigDirFlag) BeforeResolve

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

func (*ConfigDirFlag) Help

func (f *ConfigDirFlag) Help() string

type ConfigDirOption

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

func WithConfigDirLoader

func WithConfigDirLoader(loader ConfigLoader) ConfigDirOption

func WithXdgConfigPath

func WithXdgConfigPath(configPath string) ConfigDirOption

type ConfigListCmd

type ConfigListCmd struct {
}

func (*ConfigListCmd) BeforeResolve

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

func (*ConfigListCmd) Run

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

type ConfigLoader

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

type ConfigUseCmd

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

func (*ConfigUseCmd) BeforeResolve

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

func (*ConfigUseCmd) Run

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

type ProfilingFlag

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 (*ProfilingFlag) Start

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

Start starts the profiling operation. It returns a function that needs to be called when the profiling should stop.