config

Documentation

Index

• Constants
• func AddPlugins(plugins []types.PluginConfig, new []types.PluginConfig) ([]types.PluginConfig, error)
• func AspectBaseUrl(isProTier bool) string
• func HomeConfigFile() (string, error)
• func HomeConfigFolder() (string, error)
• func IsProTier(tier string) bool
• func IsValidTier(tier string) bool
• func Load(v *viper.Viper, args []string) error
• func LoadConfigFile(f string) (*viper.Viper, error)
• func LoadHomeConfig() (*viper.Viper, error)
• func LoadSystemConfig() (*viper.Viper, error)
• func LoadWorkspaceConfig() (*viper.Viper, error)
• func MarshalPluginConfig(plugins []types.PluginConfig) interface{}
• func MaybeLoadConfigFile(f string) (*viper.Viper, error)
• func SetInHomeConfig(key string, value interface{}) (string, bool, error)
• func SetInWorkspaceConfig(key string, value interface{}) (string, bool, error)
• func SystemConfigFile() string
• func UnmarshalPluginConfig(pluginsConfig interface{}) ([]types.PluginConfig, error)
• func WorkspaceConfigFile() (string, error)
• func WorkspaceConfigFolder() (string, error)
• func Write(v *viper.Viper) error
• type ConfigFlagValues
  • func ParseConfigFlags(args []string) (*ConfigFlagValues, error)
• type VersionConfig
  • func GetVersionConfig() (*VersionConfig, error)
• type VersionTuple
  • func ParseConfigVersion(version string) (VersionTuple, error)

Constants

const (
	AspectSystemConfigFolder = "/etc/aspect/cli" // for linux & darwin
	AspectConfigFolder       = ".aspect/cli"
	AspectConfigFile         = "config.yaml"
)

Functions

func AddPlugins

func AddPlugins(plugins []types.PluginConfig, new []types.PluginConfig) ([]types.PluginConfig, error)

func AspectBaseUrl

func AspectBaseUrl(isProTier bool) string

func HomeConfigFile

func HomeConfigFile() (string, error)

func HomeConfigFolder

func HomeConfigFolder() (string, error)

func IsProTier

func IsProTier(tier string) bool

func IsValidTier

func IsValidTier(tier string) bool

func Load

func Load(v *viper.Viper, args []string) error

func LoadConfigFile

func LoadConfigFile(f string) (*viper.Viper, error)

Load a config file and fail if it is not found

func LoadHomeConfig

func LoadHomeConfig() (*viper.Viper, error)

func LoadSystemConfig

func LoadSystemConfig() (*viper.Viper, error)

func LoadWorkspaceConfig

func LoadWorkspaceConfig() (*viper.Viper, error)

func MarshalPluginConfig

func MarshalPluginConfig(plugins []types.PluginConfig) interface{}

func MaybeLoadConfigFile

func MaybeLoadConfigFile(f string) (*viper.Viper, error)

Load a config file if it is found

func SetInHomeConfig

func SetInHomeConfig(key string, value interface{}) (string, bool, error)

Sets a value in the Aspect CLI $HOME configuration. Returns the path of the config file written to & true if the configuration file is newly created.

func SetInWorkspaceConfig

func SetInWorkspaceConfig(key string, value interface{}) (string, bool, error)

Sets a value in the Aspect CLI $WORKSPACE configuration. Returns the path of the config file written to & true if the configuration file is newly created.

func SystemConfigFile

func SystemConfigFile() string

func UnmarshalPluginConfig

func UnmarshalPluginConfig(pluginsConfig interface{}) ([]types.PluginConfig, error)

func WorkspaceConfigFile

func WorkspaceConfigFile() (string, error)

func WorkspaceConfigFolder

func WorkspaceConfigFolder() (string, error)

func Write

func Write(v *viper.Viper) error

Types

type ConfigFlagValues

type ConfigFlagValues struct {
	UserConfigs     []string
	SystemConfig    bool
	WorkspaceConfig bool
	HomeConfig      bool
}

func ParseConfigFlags

func ParseConfigFlags(args []string) (*ConfigFlagValues, error)

type VersionConfig

type VersionConfig struct {
	VersionTuple
	Configured bool
	AutoTier   bool
	BaseUrl    string
	IsProTier  bool
}

func GetVersionConfig

func GetVersionConfig() (*VersionConfig, error)

type VersionTuple

type VersionTuple struct {
	Tier    string
	Version string
}

func ParseConfigVersion

func ParseConfigVersion(version string) (VersionTuple, error)