config

type Command ¶

type Command struct {
	Cmd  string   `arg:"positional"`
	Args []string `arg:"positional"`
}

Command represents a command (start, stop, etc.) and its values.

type CommandLine ¶

type CommandLine struct {
	Options
	Command
}

CommandLine represents options (--addr, etc.) and commands (start, etc.). The caller is expected to copy and use the embedded structs separately, like:

var o config.Options = cmdLine.Options
var c config.Command = cmdLine.Command

Some commands and options are mutually exclusive, like --ping and --version. Others can be used together, like --addr and --timeout with any command.

func ParseCommandLine(def Options) CommandLine

type Options ¶

type Options struct {
	Addr    string `arg:"env:SPINC_ADDR" yaml:"addr"`
	Config  string `arg:"env:SPINC_CONFIG"`
	Debug   bool   `arg:"env:SPINC_DEBUG" yaml:"debug"`
	Env     string `arg:"env:SPINC_ENV" yaml:"env"`
	Help    bool
	Timeout uint `arg:"env:SPINC_TIMEOUT" yaml:"timeout"`
	Version bool
}

Options represents typical command line options: --addr, --config, etc.

func ParseConfigFiles(files string, debug bool) Options

type UserCommandLine ¶ added in v2.0.6

type UserCommandLine struct {
	UserOptions
	Command
}

type UserOptions ¶ added in v2.0.6

type UserOptions struct {
	Addr    *string
	Config  *string
	Debug   *bool
	Env     *string
	Help    *bool
	Timeout *uint
	Version *bool
}

An Options record for pulling the originally set user arguments

func ParseUserOptions(def UserOptions) UserOptions

func (u *UserOptions) ToOptions() Options