config

Documentation

Overview

Package config handle user credentials and config fetching/saving

Index

• Variables
• type Config
  • func Load(basePath string) (Config, error)
• type CredentialsConfig
• type FirstTimeError
  • func (e *FirstTimeError) Error() string
• type GeneralConfig

Variables

var (
	PathCredentialsFile = ".config/gira/credentials.toml"
	PathLogsDir         = ".config/gira/logs/"
)

Types

type Config

type Config struct {
	General     GeneralConfig     `toml:"general"`
	Credentials CredentialsConfig `toml:"credentials"`
}

Config represents the application configuration

func Load

func Load(basePath string) (Config, error)

Load reads and parses the configuration file from ~/.config/gira/credentials.toml If the file doesn't exist, it creates it with example values

type CredentialsConfig

type CredentialsConfig struct {
	Email  string `toml:"email"`
	Secret string `toml:"secret"`
	Domain string `toml:"domain"`
}

CredentialsConfig holds user credentials

type FirstTimeError

type FirstTimeError struct {
	Message string
}

func (*FirstTimeError) Error

func (e *FirstTimeError) Error() string

type GeneralConfig

type GeneralConfig struct {
	Debug bool `toml:"debug"`
}

GeneralConfig holds general application settings