config

Documentation

Index

• Constants
• type Config
  • func (c *Config) EditConfig() error
  • func (c *Config) GetConfigFolder(xdgPath string) string
  • func (c *Config) InitConfig()
  • func (c *Config) ListProfiles() []string
  • func (c *Config) RemoveAllProfiles() error
  • func (c *Config) UseWorkspace(local bool, teamId string, teamMode string) error
  • func (c *Config) WriteGlobalConfig() error
  • func (c *Config) WriteLocalConfig() error
• type Profile
  • func (p *Profile) GetConfigField(field string) string
  • func (p *Profile) RemoveProfile() error
  • func (p *Profile) SaveProfile(local bool) error
  • func (p *Profile) UseProfile() error
  • func (p *Profile) ValidateAPIKey() error

Constants

const ColorAuto = "auto"

ColorAuto represents the auto-state for colors

const ColorOff = "off"

ColorOff represents the off-state for colors

const ColorOn = "on"

ColorOn represnets the on-state for colors

Types

type Config

type Config struct {
	Profile    Profile
	Color      string
	LogLevel   string
	DeviceName string

	// Helpers
	APIBaseURL       string
	DashboardBaseURL string
	ConsoleBaseURL   string
	WSBaseURL        string
	Insecure         bool

	// Config
	GlobalConfigFile string
	GlobalConfig     *viper.Viper
	LocalConfigFile  string
	LocalConfig      *viper.Viper
}

Config handles all overall configuration for the CLI

func (*Config) EditConfig

func (c *Config) EditConfig() error

EditConfig opens the configuration file in the default editor.

func (*Config) GetConfigFolder

func (c *Config) GetConfigFolder(xdgPath string) string

GetConfigFolder retrieves the folder where the profiles file is stored It searches for the xdg environment path first and will secondarily place it in the home directory

func (*Config) InitConfig

func (c *Config) InitConfig()

InitConfig reads in profiles file and ENV variables if set.

func (*Config) ListProfiles

func (c *Config) ListProfiles() []string

func (*Config) RemoveAllProfiles

func (c *Config) RemoveAllProfiles() error

RemoveAllProfiles removes all the profiles from the config file.

func (*Config) UseWorkspace

func (c *Config) UseWorkspace(local bool, teamId string, teamMode string) error

UseWorkspace selects the active workspace to be used

func (*Config) WriteGlobalConfig

func (c *Config) WriteGlobalConfig() error

func (*Config) WriteLocalConfig

func (c *Config) WriteLocalConfig() error

type Profile

type Profile struct {
	Name     string // profile name
	APIKey   string
	TeamID   string
	TeamMode string

	Config *Config
}

func (*Profile) GetConfigField

func (p *Profile) GetConfigField(field string) string

GetConfigField returns the configuration field for the specific profile

func (*Profile) RemoveProfile

func (p *Profile) RemoveProfile() error

func (*Profile) SaveProfile

func (p *Profile) SaveProfile(local bool) error

func (*Profile) UseProfile

func (p *Profile) UseProfile() error

func (*Profile) ValidateAPIKey

func (p *Profile) ValidateAPIKey() error