config

Documentation

Index

• func Exists() bool
• func GetConversationDirectory() string
• func GetHomeDir() string
• func GetKnowledgeDirectory() string
• func GetModuleDirectory(subdir string) string
• func GetProgramDirectory() string
• func GetPromptDirectory() string
• func SaveConfig(cfg *Config) error
• type Config
  • func DefaultConfig() Config
  • func LoadConfig() (*Config, error)
• type InputConfig
• type OutputConfig
• type SpeechConfig
• type SqliteConfig
• type VoiceConfig

Functions

func Exists

func Exists() bool

Exists checks if the configuration file exists.

func GetConversationDirectory

func GetConversationDirectory() string

func GetHomeDir

func GetHomeDir() string

GetHomeDir returns the user's home directory.

func GetKnowledgeDirectory

func GetKnowledgeDirectory() string

func GetModuleDirectory

func GetModuleDirectory(subdir string) string

GetModuleDirectory returns the specified subdirectory under the data directory.

func GetProgramDirectory

func GetProgramDirectory() string

GetProgramDirectory returns the application's data directory e.g., ~/.nomi on Unix systems.

func GetPromptDirectory

func GetPromptDirectory() string

func SaveConfig

func SaveConfig(cfg *Config) error

SaveConfig saves the configuration to the YAML file.

Types

type Config

type Config struct {
	Input     InputConfig  `yaml:"input"      json:"input"`
	Output    OutputConfig `yaml:"output"     json:"output"`
	DevMode   bool         `yaml:"dev_mode"   json:"dev_mode"`
	PlaySound bool         `yaml:"play_sound" json:"play_sound"`
}

func DefaultConfig

func DefaultConfig() Config

defaultConfig returns the default configuration.

func LoadConfig

func LoadConfig() (*Config, error)

LoadConfig loads the configuration from the YAML file or creates a default one if it doesn't exist.

type InputConfig

type InputConfig struct {
	Voice VoiceConfig `yaml:"voice" json:"voice"`
}

Manage the input sources

type OutputConfig

type OutputConfig struct {
	Sqlite SqliteConfig `yaml:"sqlite" json:"sqlite"`
	Speech SpeechConfig `yaml:"speech" json:"speech"`
}

type SpeechConfig

type SpeechConfig struct {
	Enabled bool `yaml:"enabled" json:"enabled"`
}

type SqliteConfig

type SqliteConfig struct {
	Enabled bool   `yaml:"enabled" json:"enabled"`
	Path    string `yaml:"path"    json:"path"`
}

type VoiceConfig

type VoiceConfig struct {
	Enabled  bool   `yaml:"enabled"  json:"enabled"`
	Language string `yaml:"language" json:"language"`
	KeyCode  uint16 `yaml:"keyCode"  json:"keyCode"`
}