cmdconfig

package
v0.14.0-alpha.15 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 27, 2022 License: AGPL-3.0 Imports: 13 Imported by: 0

Documentation

Overview

Package cmd_config contains helper functions to support constructing Cobra commands, validating arguments and populating Viper config management

Index

Constants

This section is empty.

Variables

View Source
var FlagOptions = struct {
	Required   func() flagOpt
	Hidden     func() flagOpt
	Deprecated func(string) flagOpt
}{
	Required:   requiredOpt,
	Hidden:     hiddenOpt,
	Deprecated: deprecatedOpt,
}

FlagOptions :: shortcut for common flag options

Functions

func BootstrapViper added in v0.13.0

func BootstrapViper()

BootstrapViper sets up viper with the essential path config (workspace-chdir and install-dir)

func GetCloudMetadata added in v0.13.0

func GetCloudMetadata() (*steampipeconfig.CloudMetadata, error)

func SetViperDefaults added in v0.3.0

func SetViperDefaults(configMap map[string]interface{})

SetViperDefaults sets up viper with default values for all config which is set via hcl config or env vars

func Viper

func Viper() *viper.Viper

Viper fetches the global viper instance

Types

type CmdBuilder added in v0.3.0

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

func OnCmd

func OnCmd(cmd *cobra.Command) *CmdBuilder

OnCmd starts a config builder wrapping over the provided *cobra.Command

func (*CmdBuilder) AddBoolFlag added in v0.3.0

func (c *CmdBuilder) AddBoolFlag(name, shorthand string, defaultValue bool, desc string, opts ...flagOpt) *CmdBuilder

AddBoolFlag ia s helper function to add a boolean flag to a command

func (*CmdBuilder) AddIntFlag added in v0.3.0

func (c *CmdBuilder) AddIntFlag(name, shorthand string, defaultValue int, desc string, opts ...flagOpt) *CmdBuilder

AddIntFlag is a helper function to add an integer flag to a command

func (*CmdBuilder) AddStringArrayFlag added in v0.8.0

func (c *CmdBuilder) AddStringArrayFlag(name, shorthand string, defaultValue []string, desc string, opts ...flagOpt) *CmdBuilder

AddStringArrayFlag is a helper function to add a flag that accepts an array of strings

func (*CmdBuilder) AddStringFlag added in v0.3.0

func (c *CmdBuilder) AddStringFlag(name string, shorthand string, defaultValue string, desc string, opts ...flagOpt) *CmdBuilder

AddStringFlag is a helper function to add a string flag to a command

func (*CmdBuilder) AddStringMapStringFlag added in v0.3.0

func (c *CmdBuilder) AddStringMapStringFlag(name, shorthand string, defaultValue map[string]string, desc string, opts ...flagOpt) *CmdBuilder

AddStringMapStringFlag is a helper function to add a flag that accepts a map of strings

func (*CmdBuilder) AddStringSliceFlag added in v0.3.0

func (c *CmdBuilder) AddStringSliceFlag(name, shorthand string, defaultValue []string, desc string, opts ...flagOpt) *CmdBuilder

AddStringSliceFlag is a helper function to add a flag that accepts an array of strings

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL