config

Documentation

Index

• Constants
• Variables
• func WithConfig(f func(c *Config))
• func WithConfigFrom(configDir string, f func(c *Config))
• type Config
  • func LoadConfig(configDir string) (*Config, error)
  • func (c *Config) Delete(key string) error
  • func (c *Config) Get(key string)
  • func (c *Config) List()
  • func (c *Config) Set(key string, value interface{}) error
• type Ternary
  • func (t Ternary) Bool() bool
  • func (t Ternary) String() string
  • func (t Ternary) Valid() error
• type Value
  • func (c *Value) IsDefault() bool

Constants

const (
	// DefaultConfigName is the default name of the global configuration file
	DefaultConfigName = "config"

	// DefaultConfigType to read, though any file type supported by viper is allowed
	DefaultConfigType = "json"

	// DefaultEnvPrefix is used when reading environment variables
	DefaultEnvPrefix = "NEW_RELIC_CLI"

	// DefaultLogLevel is the default log level
	DefaultLogLevel = "INFO"
)

Variables

var Command = &cobra.Command{
	Use:   "config",
	Short: "Manage the configuration of the New Relic CLI",
}

Command is the base command for managing profiles

var (
	// DefaultConfigDirectory is the default location for the CLI config files
	DefaultConfigDirectory string
)

var TernaryValues = struct {
	// Allow the option
	Allow Ternary

	// Disallow the option
	Disallow Ternary

	// Unknown is the unknown state
	Unknown Ternary
}{
	Allow:    "ALLOW",
	Disallow: "DISALLOW",
	Unknown:  "NOT_ASKED",
}

TernaryValues provides the set of Ternary values

Functions

func WithConfig

func WithConfig(f func(c *Config))

WithConfig loads and returns the CLI configuration.

func WithConfigFrom

func WithConfigFrom(configDir string, f func(c *Config))

WithConfigFrom loads and returns the CLI configuration from a specified location.

Types

type Config

type Config struct {
	LogLevel           string  `mapstructure:"logLevel"`           // LogLevel for verbose output
	PluginDir          string  `mapstructure:"pluginDir"`          // PluginDir is the directory where plugins will be installed
	SendUsageData      Ternary `mapstructure:"sendUsageData"`      // SendUsageData enables sending usage statistics to New Relic
	PreReleaseFeatures Ternary `mapstructure:"preReleaseFeatures"` // PreReleaseFeatures enables display on features within the CLI that are announced but not generally available to customers
	// contains filtered or unexported fields
}

Config contains the main CLI configuration

func LoadConfig

func LoadConfig(configDir string) (*Config, error)

LoadConfig loads the configuration from disk, substituting defaults if the file does not exist.

func (*Config) Delete

func (c *Config) Delete(key string) error

Delete deletes a config value. This has the effect of reverting the value back to its default.

func (*Config) Get

func (c *Config) Get(key string)

Get retrieves a config value.

func (*Config) List

func (c *Config) List()

List outputs a list of all the configuration values

func (*Config) Set

func (c *Config) Set(key string, value interface{}) error

Set sets a config value.

type Ternary

type Ternary string

Ternary is like a bool, but includes the unknown state

func (Ternary) Bool

func (t Ternary) Bool() bool

Bool returns true if the ternary is set and contains the true value

func (Ternary) String

func (t Ternary) String() string

String returns the string value of the ternary

func (Ternary) Valid

func (t Ternary) Valid() error

Valid returns true for a valid value, false otherwise

type Value

type Value struct {
	Name    string
	Value   interface{}
	Default interface{}
}

Value represents an instance of a configuration field.

func (*Value) IsDefault

func (c *Value) IsDefault() bool

IsDefault returns true if the field's value is the default value.