config

package

v0.2.0 Latest Latest Go to latest Published: Oct 22, 2025 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/AYM1607/godig

Links

Open Source Insights

Documentation ¶

Index ¶

func GetConfigValue(key ConfigKey) (string, error)
func SaveGlobalConfig(config *GlobalConfig) error
func SetConfigValue(key ConfigKey, value string) error
type ConfigKey
type GlobalConfig
- func LoadGlobalConfig() (*GlobalConfig, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetConfigValue ¶

func GetConfigValue(key ConfigKey) (string, error)

GetConfigValue retrieves a specific configuration value.

func SaveGlobalConfig ¶

func SaveGlobalConfig(config *GlobalConfig) error

SaveGlobalConfig saves the global configuration to ~/.config/godig/config.yaml.

func SetConfigValue ¶

func SetConfigValue(key ConfigKey, value string) error

SetConfigValue sets a specific configuration value and saves it.

Types ¶

type ConfigKey ¶

type ConfigKey string

ConfigKey represents a configuration key.

const (
	// KeyAPIKey is the configuration key for the API key.
	KeyAPIKey ConfigKey = "api-key"
	// KeyServer is the configuration key for the server address.
	KeyServer ConfigKey = "server"
)

type GlobalConfig ¶

type GlobalConfig struct {
	APIKey string `yaml:"api_key,omitempty"`
	Server string `yaml:"server,omitempty"`
}

GlobalConfig represents the user's global configuration.

func LoadGlobalConfig ¶

func LoadGlobalConfig() (*GlobalConfig, error)

LoadGlobalConfig loads the global configuration from ~/.config/godig/config.yaml. Returns an empty config if the file doesn't exist.

Source Files ¶

View all Source files

global.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL