config

Documentation

Index

• Constants
• func ConfigPath() string
• func DeleteAPIKey(profileName string) error
• func EnsureConfigDir() error
• func GetAPIKey(profileName string) (string, error)
• func Save(configuration *Config) error
• func StoreAPIKey(profileName string, apiKey string) error
• type Config
  • func Load() (*Config, error)
• type Profile
  • func GetActiveProfile(configuration *Config) (*Profile, error)

Constants

const (
	DefaultAPIURL  = "https://api.ararahq.com/api"
	ConfigDir      = ".arara"
	ConfigFileName = "config.yaml"
	DefaultOutput  = "table"
	DefaultMode    = "test"
)

const (
	AuthTypeAPIKey = "apikey"
	AuthTypeOAuth  = "oauth"
)

const ServiceName = "ararahq-cli"

Functions

func ConfigPath

func ConfigPath() string

func DeleteAPIKey

func DeleteAPIKey(profileName string) error

func EnsureConfigDir

func EnsureConfigDir() error

func GetAPIKey

func GetAPIKey(profileName string) (string, error)

func Save

func Save(configuration *Config) error

func StoreAPIKey

func StoreAPIKey(profileName string, apiKey string) error

Types

type Config

type Config struct {
	CurrentProfile string             `yaml:"current_profile"`
	Output         string             `yaml:"output"`
	Profiles       map[string]Profile `yaml:"profiles"`
}

func Load

func Load() (*Config, error)

type Profile

type Profile struct {
	APIKey   string `yaml:"api_key"`
	APIURL   string `yaml:"api_url"`
	Mode     string `yaml:"mode"`
	AuthType string `yaml:"auth_type,omitempty"`
}

func GetActiveProfile

func GetActiveProfile(configuration *Config) (*Profile, error)