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) PrintConfig() error
  • func (c *Config) RemoveAllProfiles() error
  • func (c *Config) RemoveProfile(profileName string) error
• type Profile
  • func (p *Profile) CreateProfile() error
  • func (p *Profile) DeleteConfigField(field string) error
  • func (p *Profile) GetAPIKey() (string, error)
  • func (p *Profile) GetColor() (string, error)
  • func (p *Profile) GetConfigField(field string) string
  • func (p *Profile) GetDeviceName() (string, error)
  • func (p *Profile) GetDisplayName() string
  • func (p *Profile) GetTeamName() string
  • func (p *Profile) GetTerminalPOSDeviceID() string
  • func (p *Profile) RegisterAlias(alias, key string)
  • func (p *Profile) WriteConfigField(field, value string) 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 {
	Color            string
	LogLevel         string
	Profile          Profile
	ProfilesFile     string
	APIBaseURL       string
	DashboardBaseURL string
	Insecure         bool
}

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) PrintConfig

func (c *Config) PrintConfig() error

PrintConfig outputs the contents of the configuration file.

func (*Config) RemoveAllProfiles

func (c *Config) RemoveAllProfiles() error

RemoveAllProfiles removes all the profiles from the config file.

func (*Config) RemoveProfile

func (c *Config) RemoveProfile(profileName string) error

RemoveProfile removes the profile whose name matches the provided profileName from the config file.

type Profile

type Profile struct {
	Config      *Config
	DeviceName  string
	ProfileName string
	TeamName    string
	APIKey      string
	ClientID    string
	DisplayName string
}

Profile handles all things related to managing the project specific configurations

func (*Profile) CreateProfile

func (p *Profile) CreateProfile() error

CreateProfile creates a profile when logging in

func (*Profile) DeleteConfigField

func (p *Profile) DeleteConfigField(field string) error

DeleteConfigField deletes a configuration field.

func (*Profile) GetAPIKey

func (p *Profile) GetAPIKey() (string, error)

GetAPIKey will return the existing key for the given profile

func (*Profile) GetColor

func (p *Profile) GetColor() (string, error)

GetColor gets the color setting for the user based on the flag or the persisted color stored in the config file

func (*Profile) GetConfigField

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

GetConfigField returns the configuration field for the specific profile

func (*Profile) GetDeviceName

func (p *Profile) GetDeviceName() (string, error)

GetDeviceName returns the configured device name

func (*Profile) GetDisplayName

func (p *Profile) GetDisplayName() string

GetDisplayName returns the account display name of the user

func (*Profile) GetTeamName

func (p *Profile) GetTeamName() string

GetDisplayName returns the account display name of the team

func (*Profile) GetTerminalPOSDeviceID

func (p *Profile) GetTerminalPOSDeviceID() string

GetTerminalPOSDeviceID returns the device id from the config for Terminal quickstart to use

func (*Profile) RegisterAlias

func (p *Profile) RegisterAlias(alias, key string)

RegisterAlias registers an alias for a given key.

func (*Profile) WriteConfigField

func (p *Profile) WriteConfigField(field, value string) error

WriteConfigField updates a configuration field and writes the updated configuration to disk.