options

package

v1.0.0 Latest Latest Go to latest Published: May 31, 2023 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Bio-OS/bioos

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func GetCommonRunFunc(o Options) func(cmd *cobra.Command, args []string)
func LoadConfigFile(configFile string, opt *GlobalOptions)
func SetConfigEnv()
type ClientOptions
type GlobalOptions
- func (o GlobalOptions) Validate() error
type Options
type StreamOptions
- func (o StreamOptions) Validate() error

Constants ¶

View Source

const (
	ConfigFlagName    = "config"
	DefaultConfigName = "bioctl.yaml"
)

Variables ¶

View Source

var CfgFile string

View Source

var DefaultConfig = GlobalOptions{
	Client: ClientOptions{
		Insecure: true,
		Method:   client.HTTPMethod,
		Timeout:  30,
	},
	Stream: StreamOptions{
		Input:       os.Stdin,
		Output:      os.Stdout,
		ErrorOutput: os.Stderr,
	},
}

Functions ¶

func GetCommonRunFunc ¶

func GetCommonRunFunc(o Options) func(cmd *cobra.Command, args []string)

func LoadConfigFile ¶

func LoadConfigFile(configFile string, opt *GlobalOptions)

LoadConfigFile load config file

func SetConfigEnv ¶

func SetConfigEnv()

Types ¶

type ClientOptions ¶

type ClientOptions = client.Options

type GlobalOptions ¶

type GlobalOptions struct {
	Client ClientOptions `json:"client" mapstructure:"client"`
	Stream StreamOptions `json:"stream" mapstructure:"stream"`
}

func (GlobalOptions) Validate ¶

func (o GlobalOptions) Validate() error

type Options ¶

type Options interface {
	Complete() error
	Validate() error
	Run(args []string) error
	GetPromptArgs() ([]string, error)
	GetPromptOptions() error
	GetDefaultFormat() formatter.Format
}

type StreamOptions ¶

type StreamOptions struct {
	// input stream, eg: os.Stdin
	Input io.Reader `json:"input,omitempty"`
	// output stream, eg: os.Stdout
	Output io.Writer `json:"output,omitempty"`
	// error stream, eg: os.Stderr
	ErrorOutput io.Writer `json:"errorOutput,omitempty"`
	// output format, eg: text,table,json
	OutputFormat formatter.Format `json:"format,omitempty" mapstructure:"format,omitempty"`
}

func (StreamOptions) Validate ¶

func (o StreamOptions) Validate() error

Source Files ¶

View all Source files

options.go

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