options

Documentation

Overview

Package options is a common options interface that is used by CLI, args, and the gRPC server. Its purpose is primarily to store all available options for plumber - its other responsibilities are to perform "light" validation.

Additional validation should be performed by the utilizers of the options package.

Index

• Variables
• func ActionUsesBackend(action string) bool
• func New(args []string) (*kong.Context, *opts.CLIOptions, error)
• func NewCLIOptions() *opts.CLIOptions

Variables

var (
	VERSION = "UNSET"
)

Functions

func ActionUsesBackend

func ActionUsesBackend(action string) bool

ActionUsesBackend checks the action string to determine if a backend will need to be utilized. This is used to determine if we need to populate XBackend or create a connection config (when in CLI mode).

func New

func New(args []string) (*kong.Context, *opts.CLIOptions, error)

func NewCLIOptions

func NewCLIOptions() *opts.CLIOptions

NewCLIOptions creates an *opts.CLIOptions with zero values. We have to do this in order to ensure that kong has valid destinations to write discovered options to.