The highest tagged major version is
Documentation
¶
Overview ¶
Package clibase offers an all-in-one solution for a highly configurable CLI application. Within Coder, we use it for our `server` subcommand, which demands more functionality than cobra/viper can offer.
We will extend its usage to the rest of our application, completely replacing cobra/viper. It's also a candidate to be broken out into its own open-source library, so we avoid deep coupling with Coder concepts.
Index ¶
- type Annotations
- type Bool
- type Cmd
- type DiscardValue
- type Duration
- type EnvVar
- type Group
- type HostPort
- type Int64
- type NoOptDefValuer
- type Option
- type OptionSet
- type String
- type Strings
- type Struct
- func (s *Struct[T]) MarshalJSON() ([]byte, error)
- func (s *Struct[T]) MarshalYAML() (interface{}, error)
- func (s *Struct[T]) Set(v string) error
- func (s *Struct[T]) String() string
- func (s *Struct[T]) Type() string
- func (s *Struct[T]) UnmarshalJSON(b []byte) error
- func (s *Struct[T]) UnmarshalYAML(n *yaml.Node) error
- type URL
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Annotations ¶
Annotations is an arbitrary key-mapping used to extend the Option and Command types. Its methods won't panic if the map is nil.
func (Annotations) Get ¶
func (a Annotations) Get(key string) (string, bool)
Get retrieves a key from the map, returning false if the key is not found or the map is nil.
func (Annotations) IsSet ¶
func (a Annotations) IsSet(key string) bool
IsSet returns true if the key is set in the annotations map.
func (Annotations) Mark ¶
func (a Annotations) Mark(key string, value string) Annotations
Mark sets a value on the annotations map, creating one if it doesn't exist. Mark does not mutate the original and returns a copy. It is suitable for chaining.
type Cmd ¶
type Cmd struct {
// Parent is the direct parent of the command.
Parent *Cmd
// Children is a list of direct descendants.
Children []*Cmd
// Use is provided in form "command [flags] [args...]".
Use string
// Short is a one-line description of the command.
Short string
// Long is a detailed description of the command,
// presented on its help page. It may contain examples.
Long string
Options OptionSet
Annotations Annotations
}
Cmd describes an executable command.
func (*Cmd) FullName ¶
FullName returns the full invocation name of the command, as seen on the command line.
type DiscardValue ¶
type DiscardValue struct{}
DiscardValue does nothing but implements the pflag.Value interface. It's useful in cases where you want to accept an option, but access the underlying value directly instead of through the Option methods.
func (DiscardValue) Set ¶
func (DiscardValue) Set(string) error
func (DiscardValue) String ¶
func (DiscardValue) String() string
func (DiscardValue) Type ¶
func (DiscardValue) Type() string
type EnvVar ¶
Var represents a single environment variable of form NAME=VALUE.
func EnvsWithPrefix ¶
EnvsWithPrefix returns all environment variables starting with prefix without said prefix.
type Group ¶
type Group struct {
Parent *Group `json:"parent,omitempty"`
Name string `json:"name,omitempty"`
Children []Group `json:"children,omitempty"`
Description string `json:"description,omitempty"`
}
Group describes a hierarchy of groups that an option or command belongs to.
type HostPort ¶
HostPort is a host:port pair.
func (*HostPort) MarshalJSON ¶
func (*HostPort) UnmarshalJSON ¶
type NoOptDefValuer ¶
type NoOptDefValuer interface {
NoOptDefValue() string
}
NoOptDefValuer describes behavior when no option is passed into the flag.
This is useful for boolean or otherwise binary flags.
type Option ¶
type Option struct {
Name string `json:"name,omitempty"`
Description string `json:"description,omitempty"`
// Flag is the long name of the flag used to configure this option. If unset,
// flag configuring is disabled.
Flag string `json:"flag,omitempty"`
// FlagShorthand is the one-character shorthand for the flag. If unset, no
// shorthand is used.
FlagShorthand string `json:"flag_shorthand,omitempty"`
// Env is the environment variable used to configure this option. If unset,
// environment configuring is disabled.
Env string `json:"env,omitempty"`
// YAML is the YAML key used to configure this option. If unset, YAML
// configuring is disabled.
YAML string `json:"yaml,omitempty"`
// Default is parsed into Value if set.
Default string `json:"default,omitempty"`
// Value includes the types listed in values.go.
Value pflag.Value `json:"value,omitempty"`
// Annotations enable extensions to clibase higher up in the stack. It's useful for
// help formatting and documentation generation.
Annotations Annotations `json:"annotations,omitempty"`
// Group is a group hierarchy that helps organize this option in help, configs
// and other documentation.
Group *Group `json:"group,omitempty"`
// UseInstead is a list of options that should be used instead of this one.
// The field is used to generate a deprecation warning.
UseInstead []Option `json:"use_instead,omitempty"`
Hidden bool `json:"hidden,omitempty"`
}
Option is a configuration option for a CLI application.
type OptionSet ¶
type OptionSet []Option
OptionSet is a group of options that can be applied to a command.
func (*OptionSet) SetDefaults ¶
SetDefaults sets the default values for each Option. It should be called before all parsing (e.g. ParseFlags, ParseEnv).
type Strings ¶
type Strings []string
Strings is a slice of strings that implements pflag.Value and pflag.SliceValue.
type Struct ¶
type Struct[T any] struct { Value T }
Struct is a special value type that encodes an arbitrary struct. It implements the flag.Value interface, but in general these values should only be accepted via config for ergonomics.
The string encoding type is YAML.
Source Files