Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ReadFromEnv ¶ added in v0.1.3397
ReadFromEnv takes a prefix and field to search the environment for after capitalizing and joining them with an underscore.
func SettingsPath ¶ added in v0.1.6893
func SettingsPath() string
settingsPath returns the path of the CLI settings directory
Types ¶
type Config ¶ added in v0.1.3397
type Config struct { Host string `yaml:"host"` Endpoint string `yaml:"endpoint"` Token string `yaml:"token"` RestEndpoint string `yaml:"rest_endpoint"` TLSCert string `yaml:"tls_cert"` TLSInsecure bool `yaml:"tls_insecure"` HTTPClient *http.Client `yaml:"-"` Data *data.YML `yaml:"-"` Debug bool `yaml:"-"` Address string `yaml:"-"` FileUsed string `yaml:"-"` GitHubAPI string `yaml:"-"` SkipUpdateCheck bool `yaml:"-"` OrbPublishing OrbPublishingInfo `yaml:"orb_publishing"` }
Config is used to represent the current state of a CLI instance.
func (*Config) Load ¶ added in v0.1.3397
Load will read the config from the user's disk and then evaluate possible configuration from the environment.
func (*Config) LoadFromDisk ¶ added in v0.1.3397
LoadFromDisk is used to read config from the user's disk and deserialize the YAML into our runtime config.
func (*Config) LoadFromEnv ¶ added in v0.1.3397
LoadFromEnv will read from environment variables of the given prefix for host, endpoint, and token specifically.
func (*Config) WithHTTPClient ¶ added in v0.1.15338
func (*Config) WriteToDisk ¶ added in v0.1.3397
WriteToDisk will write the runtime config instance to disk by serializing the YAML
type OrbPublishingInfo ¶ added in v0.1.9988
type UpdateCheck ¶ added in v0.1.4005
type UpdateCheck struct { LastUpdateCheck time.Time `yaml:"last_update_check"` FileUsed string `yaml:"-"` }
UpdateCheck is used to represent settings for checking for updates of the CLI.
func (*UpdateCheck) Load ¶ added in v0.1.4005
func (upd *UpdateCheck) Load() error
Load will read the update check settings from the user's disk and then deserialize it into the current instance.
func (*UpdateCheck) WriteToDisk ¶ added in v0.1.4005
func (upd *UpdateCheck) WriteToDisk() error
WriteToDisk will write the last update check to disk by serializing the YAML