config

Documentation

Index

• Variables
• func ClearDefaultOrgSlug() error
• func ClearDefaultProjectSlug() error
• func EnsureConfigFileExists() error
• func GetAPIBaseURL() string
• func GetAPITimeout() string
• func GetAlias(alias string) string
• func GetAllConfigKeys() []string
• func GetDefaultOrgSlug() string
• func GetDefaultProjectSlug() string
• func GetServiceName() string
• func InitConfig() error
• func IsValidConfigKey(simplified string) bool
• func ListAliases() map[string]string
• func MapSimplifiedKey(simplified string) string
• func RemoveAlias(alias string) error
• func ResetToDefaults() error
• func Save() error
• func Set(key string, value interface{}) error
• func SetAlias(alias, projectPath string) error
• func SetDefaultOrgSlug(orgSlug string) error
• func SetDefaultProjectSlug(projectSlug string) error
• type APIConfig
• type Config
  • func DefaultConfig() *Config
  • func Get() *Config
• type ConfigKey
  • func FindConfigKey(simplified string) *ConfigKey
• type LocalConfig
  • func FindLocalConfig() (*LocalConfig, error)
• type ProjectConfig
• type ProjectContext
  • func ResolveProjectContext(projectPath, org, project string) (*ProjectContext, error)
  • func (w ProjectContext) String() string

Variables

var ConfigKeys = []ConfigKey{
	{"api.url", "api.base_url", defaultAPIBaseURL},
	{"api.timeout", "api.timeout", "30s"},
	{"service", "service_name", "initiat-cli"},
	{"org", "project.default_org", ""},
	{"project", "project.default_project", ""},
}

Functions

func ClearDefaultOrgSlug

func ClearDefaultOrgSlug() error

func ClearDefaultProjectSlug

func ClearDefaultProjectSlug() error

func EnsureConfigFileExists

func EnsureConfigFileExists() error

func GetAPIBaseURL

func GetAPIBaseURL() string

GetAPIBaseURL returns the configured API base URL for production builds

func GetAPITimeout

func GetAPITimeout() string

func GetAlias

func GetAlias(alias string) string

func GetAllConfigKeys

func GetAllConfigKeys() []string

func GetDefaultOrgSlug

func GetDefaultOrgSlug() string

func GetDefaultProjectSlug

func GetDefaultProjectSlug() string

func GetServiceName

func GetServiceName() string

func InitConfig

func InitConfig() error

func IsValidConfigKey

func IsValidConfigKey(simplified string) bool

func ListAliases

func ListAliases() map[string]string

func MapSimplifiedKey

func MapSimplifiedKey(simplified string) string

func RemoveAlias

func RemoveAlias(alias string) error

func ResetToDefaults

func ResetToDefaults() error

func Save

func Save() error

func Set

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

func SetAlias

func SetAlias(alias, projectPath string) error

func SetDefaultOrgSlug

func SetDefaultOrgSlug(orgSlug string) error

func SetDefaultProjectSlug

func SetDefaultProjectSlug(projectSlug string) error

Types

type APIConfig

type APIConfig struct {
	BaseURL string `mapstructure:"base_url"`
	Timeout string `mapstructure:"timeout"`
}

type Config

type Config struct {
	API         APIConfig         `mapstructure:"api"`
	Project     ProjectConfig     `mapstructure:"project"`
	Aliases     map[string]string `mapstructure:"aliases"`
	ServiceName string            `mapstructure:"service_name"`
}

func DefaultConfig

func DefaultConfig() *Config

func Get

func Get() *Config

type ConfigKey

type ConfigKey struct {
	Simplified string
	Actual     string
	Default    interface{}
}

func FindConfigKey

func FindConfigKey(simplified string) *ConfigKey

type LocalConfig

type LocalConfig struct {
	Org     string `yaml:"org"`
	Project string `yaml:"project"`
}

func FindLocalConfig

func FindLocalConfig() (*LocalConfig, error)

type ProjectConfig

type ProjectConfig struct {
	DefaultOrg     string `mapstructure:"default_org"`
	DefaultProject string `mapstructure:"default_project"`
}

type ProjectContext

type ProjectContext struct {
	OrgSlug     string
	ProjectSlug string
}

func ResolveProjectContext

func ResolveProjectContext(projectPath, org, project string) (*ProjectContext, error)

func (ProjectContext) String

func (w ProjectContext) String() string