configure

Documentation

Index

• func NewCommand(o *Options) *cobra.Command
• func NewCurrentContextCommand(o *CurrentContextOptions) *cobra.Command
• func NewEnvCommand(o *EnvOptions) *cobra.Command
• func NewSetCommand(o *SetOptions) *cobra.Command
• func NewViewCommand(o *ViewOptions) *cobra.Command
• type CurrentContextOptions
• type EnvOptions
• type Options
• type SetOptions
  • func (o *SetOptions) Complete(args []string)
• type ViewOptions

Functions

func NewCommand

func NewCommand(o *Options) *cobra.Command

NewCommand creates a new configuration command

func NewCurrentContextCommand

func NewCurrentContextCommand(o *CurrentContextOptions) *cobra.Command

NewCurrentContextCommand creates a new command for viewing the current context

func NewEnvCommand

func NewEnvCommand(o *EnvOptions) *cobra.Command

NewEnvCommand creates a new command for viewing a configuration as environment variables

func NewSetCommand

func NewSetCommand(o *SetOptions) *cobra.Command

NewSetCommand creates a new command for setting a configuration property

func NewViewCommand

func NewViewCommand(o *ViewOptions) *cobra.Command

NewViewCommand creates a new command for viewing the configuration

Types

type CurrentContextOptions

type CurrentContextOptions struct {
	// Config is the Optimize Configuration to view
	Config *config.OptimizeConfig
	// IOStreams are used to access the standard process streams
	commander.IOStreams
}

CurrentContextOptions are the options for viewing the current context

type EnvOptions

type EnvOptions struct {
	// Config is the Optimize Configuration to view
	Config *config.OptimizeConfig
	// IOStreams are used to access the standard process streams
	commander.IOStreams

	// IncludeController is used to display the full environment
	IncludeController bool
}

EnvOptions are the options for viewing a configuration as environment variables

type Options

type Options struct {
	// Config is the Optimize Configuration
	Config *config.OptimizeConfig
}

Options includes the configuration for the subcommands

type SetOptions

type SetOptions struct {
	// Config is the Optimize Configuration to view
	Config *config.OptimizeConfig

	// Key is the name of the property being set
	Key string
	// Value is the new value for the property
	Value string
}

SetOptions are the options for setting a configuration property to a new value

func (*SetOptions) Complete

func (o *SetOptions) Complete(args []string)

Complete overwrites the options using from an argument slice

type ViewOptions

type ViewOptions struct {
	// Config is the Optimize Configuration to view
	Config *config.OptimizeConfig
	// IOStreams are used to access the standard process streams
	commander.IOStreams

	// Output is the format to output data in
	Output string
	// FileOnly causes view to just dump the configuration file to out
	FileOnly bool
	// Minify causes the configuration to be evaluated and reduced to only the current effective configuration
	Minify bool
}

ViewOptions are the options for viewing a configuration file