implement possibility to read configuration from yaml files

README.md

@@ -22,6 +22,7 @@ https://github.com/user-attachments/assets/a6d16332-55a1-4866-9f3e-31490a488935
   * [Anthropic](https://www.anthropic.com/)
 * Scriptable
   * All settings can be set via:
+    * yaml configuration file 
     * environment variables
     * command line arguments
   * The users questions and models answers will be printed out in the terminal

config/config_test.go

@@ -113,7 +113,7 @@ func TestConfig_Parse(t *testing.T) {
 			name: "Set UI file dialog resolves aliases",
 			args: []string{"--ui-file-dialog-resolves-aliases=true"},
 			expected: modifiedConfig(func(c *Config) {
-				c.UI.FileDialog.ResolvesAliases = true
+				c.UI.FileDialog.ResolveAliases = true
 			}),
 		},
 		{
@@ -257,8 +257,8 @@ func TestConfig_Parse(t *testing.T) {
 		{
 			name: "Set UI quit shortcut",
 			args: []string{
-				"--ui-quit-shortcut-key", "q",
-				"--ui-quit-shortcut-ctrl",
+				"--ui-quit-key", "q",
+				"--ui-quit-ctrl",
 			},
 			expected: modifiedConfig(func(c *Config) {
 				c.UI.QuitShortcut = Shortcut{Code: "q", Ctrl: true}
@@ -435,7 +435,7 @@ func TestConfig_Parse(t *testing.T) {
 			name: "Set environment variable for UI file dialog resolves aliases",
 			env:  []string{EnvironmentPrefix + "UI_FILE_DIALOG_RESOLVES_ALIASES=true"},
 			expected: modifiedConfig(func(c *Config) {
-				c.UI.FileDialog.ResolvesAliases = true
+				c.UI.FileDialog.ResolveAliases = true
 			}),
 		},
 		{
@@ -544,8 +544,8 @@ func TestConfig_Parse(t *testing.T) {
 		{
 			name: "Set environment variable for UI quit shortcut",
 			env: []string{
-				EnvironmentPrefix + "UI_QUIT_SHORTCUT_KEY=q",
-				EnvironmentPrefix + "UI_QUIT_SHORTCUT_CTRL=true",
+				EnvironmentPrefix + "UI_QUIT_KEY=q",
+				EnvironmentPrefix + "UI_QUIT_CTRL=true",
 			},
 			expected: modifiedConfig(func(c *Config) {
 				c.UI.QuitShortcut = Shortcut{Code: "q", Ctrl: true}

config/default.go

@@ -33,7 +33,7 @@ func defaultConfig() *Config {
 			},
 			FileDialog: FileDialogConfig{
 				ShowHiddenFiles:            true,
-				ResolvesAliases:            true,
+				ResolveAliases:             true,
 				TreatPackagesAsDirectories: true,
 				FilterDisplay:              []string{},
 				FilterPattern:              []string{},
@@ -60,7 +60,7 @@ func defaultConfig() *Config {
 		Printer: PrinterConfig{
 			Format:     PrinterFormatJSON,
 			Targets:    []io.WriteCloser{os.Stdout},
-			TargetsRaw: PrinterTargetOut,
+			TargetsRaw: []string{PrinterTargetOut},
 		},
 	}
 }

config/expression.go

@@ -9,8 +9,8 @@ import (
 )
 
 type ExpressionContainer struct {
-	Expression string  `config:""`
-	Value      float64 `config:"-"`
+	Expression string  `config:"" yaml:"expression"`
+	Value      float64 `config:"-" yaml:"value"`
 }
 
 type Expression string

config/general.go

@@ -7,14 +7,14 @@ import (
 )
 
 type Config struct {
-	UI UIConfig `config:"ui"`
+	UI UIConfig `yaml:"ui"`
 
-	LLM llm.LLMConfig `config:""`
+	LLM llm.LLMConfig `config:"" yaml:"llm"`
 
-	Printer PrinterConfig `config:"print"`
+	Printer PrinterConfig `yaml:"print"`
 
-	LogLevel     int  `config:"log-level"`
-	PrintVersion bool `config:"version" short:"v" usage:"Show the version"`
+	LogLevel     int  `yaml:"log-level"`
+	PrintVersion bool `config:"version" yaml:"-" short:"v" usage:"Show the version"`
 }
 
 func (c *Config) GetUsage(field string) string {

config/help.go

@@ -63,6 +63,24 @@ func printUsage(output io.Writer, fields resolvedFieldInfos) {
 		fmt.Fprintf(output, "  %s%s\t%s\n", env, strings.Repeat(" ", maxLen-len(env)), field.Usage)
 	}
 
+	sort.Slice(fields, func(i, j int) bool {
+		return strings.Join(fields[i].YamlPath, "") < strings.Join(fields[j].YamlPath, "")
+	})
+
+	fmt.Fprintf(output, "\nYaml keys:\n")
+	for _, field := range fields {
+		yamlKey := strings.TrimLeft(strings.Join(field.YamlPath, "."), ".")
+		if strings.HasSuffix(yamlKey, "-") {
+			continue
+		}
+		fmt.Fprintf(output, "  %s%s\t%s\n", yamlKey, strings.Repeat(" ", maxLen-len(yamlKey)), field.Usage)
+	}
+
+	fmt.Fprintf(output, "\nYaml lookup file locations:\n")
+	for _, location := range yamlLookupLocations() {
+		fmt.Fprintf(output, "  - %s\n", location)
+	}
+
 	fmt.Fprintf(output, "\nAvailable code styles:\n")
 	for _, style := range availableCodeStyles {
 		fmt.Fprintf(output, "  - %s\n", style)

config/llm/anthropic.go

@@ -6,9 +6,9 @@ import (
 )
 
 type AnthropicConfig struct {
-	Token   string `config:"api-key" usage:"API Key"`
-	BaseUrl string `config:"base-url" usage:"BaseUrl"`
-	Model   string `config:"model" usage:"Model"`
+	Token   string `yaml:"api-key" usage:"API Key"`
+	BaseUrl string `yaml:"base-url" usage:"BaseUrl"`
+	Model   string `yaml:"model" usage:"Model"`
 }
 
 func (c *AnthropicConfig) AsOptions() (opts []anthropic.Option) {

config/llm/anythingllm.go

@@ -5,9 +5,9 @@ import (
 )
 
 type AnythingLLMConfig struct {
-	BaseURL   string `config:"base-url" usage:"Base URL"`
-	Token     string `config:"token" usage:"Token"`
-	Workspace string `config:"workspace" usage:"Workspace"`
+	BaseURL   string `yaml:"base-url" usage:"Base URL"`
+	Token     string `yaml:"token" usage:"Token"`
+	Workspace string `yaml:"workspace" usage:"Workspace"`
 }
 
 func (c *AnythingLLMConfig) Validate() error {

config/llm/calloptions.go

@@ -6,13 +6,13 @@ import (
 )
 
 type CallOptionsConfig struct {
-	SystemPrompt string  `config:"system-prompt" short:"S" usage:"System Prompt"`
-	MaxToken     int     `config:"max-token" usage:"Max Token"`
-	Temperature  float64 `config:"temperature" usage:"Temperature"`
-	TopK         int     `config:"top-k" usage:"Top-K"`
-	TopP         float64 `config:"top-p" usage:"Top-P"`
-	MinLength    int     `config:"min-length" usage:"Min Length"`
-	MaxLength    int     `config:"max-length" usage:"Max Length"`
+	SystemPrompt string  `yaml:"system-prompt" short:"S" usage:"System Prompt"`
+	MaxToken     int     `yaml:"max-token" usage:"Max Token"`
+	Temperature  float64 `yaml:"temperature" usage:"Temperature"`
+	TopK         int     `yaml:"top-k" usage:"Top-K"`
+	TopP         float64 `yaml:"top-p" usage:"Top-P"`
+	MinLength    int     `yaml:"min-length" usage:"Min Length"`
+	MaxLength    int     `yaml:"max-length" usage:"Max Length"`
 }
 
 func (c *CallOptionsConfig) AsOptions() (opts []llms.CallOption) {

config/llm/general.go

@@ -16,15 +16,15 @@ const (
 )
 
 type LLMConfig struct {
-	Backend string `config:"backend" short:"b"`
+	Backend string `yaml:"backend" short:"b"`
 
-	LocalAI     LocalAIConfig     `config:"localai" usage:"LocalAI: "`
-	OpenAI      OpenAIConfig      `config:"openai" usage:"OpenAI: "`
-	AnythingLLM AnythingLLMConfig `config:"anythingllm" usage:"AnythingLLM: "`
-	Ollama      OllamaConfig      `config:"ollama" usage:"Ollama: "`
-	Mistral     MistralConfig     `config:"mistral" usage:"Mistral: "`
-	Anthropic   AnthropicConfig   `config:"anthropic" usage:"Anthropic: "`
-	CallOptions CallOptionsConfig `config:"call" usage:"LLM-CALL: "`
+	LocalAI     LocalAIConfig     `yaml:"localai" usage:"LocalAI: "`
+	OpenAI      OpenAIConfig      `yaml:"openai" usage:"OpenAI: "`
+	AnythingLLM AnythingLLMConfig `yaml:"anythingllm" usage:"AnythingLLM: "`
+	Ollama      OllamaConfig      `yaml:"ollama" usage:"Ollama: "`
+	Mistral     MistralConfig     `yaml:"mistral" usage:"Mistral: "`
+	Anthropic   AnthropicConfig   `yaml:"anthropic" usage:"Anthropic: "`
+	CallOptions CallOptionsConfig `yaml:"call" usage:"LLM-CALL: "`
 }
 
 func (c *LLMConfig) GetUsage(field string) string {

config/llm/localai.go

@@ -2,20 +2,13 @@ package llm
 
 import (
 	"fmt"
-	flag "github.com/spf13/pflag"
 	"github.com/tmc/langchaingo/llms/openai"
 )
 
 type LocalAIConfig struct {
-	APIKey  string `config:"api-key" usage:"API Key"`
-	Model   string `config:"model" usage:"Model"`
-	BaseUrl string `config:"base-url" usage:"BaseUrl"`
-}
-
-func configureLocalai(c *LocalAIConfig) {
-	flag.StringVar(&c.APIKey, "localai-api-key", "", "LocalAI API Key")
-	flag.StringVar(&c.Model, "localai-model", "", "LocalAI chat model")
-	flag.StringVar(&c.BaseUrl, "localai-base-url", "", "LocalAI API Base-URL")
+	APIKey  string `yaml:"api-key" usage:"API Key"`
+	Model   string `yaml:"model" usage:"Model"`
+	BaseUrl string `yaml:"base-url" usage:"BaseUrl"`
 }
 
 func (c *LocalAIConfig) AsOptions() (opts []openai.Option) {

config/llm/mistral.go

@@ -2,20 +2,13 @@ package llm
 
 import (
 	"fmt"
-	flag "github.com/spf13/pflag"
 	"github.com/tmc/langchaingo/llms/mistral"
 )
 
 type MistralConfig struct {
-	ApiKey   string `config:"api-key" usage:"API Key"`
-	Endpoint string `config:"endpoint" usage:"Endpoint"`
-	Model    string `config:"model" usage:"Model"`
-}
-
-func configureMistral(c *MistralConfig) {
-	flag.StringVar(&c.ApiKey, "mistral-api-key", "", "API Key for Mistral")
-	flag.StringVar(&c.Endpoint, "mistral-endpoint", "", "Endpoint for Mistral")
-	flag.StringVar(&c.Model, "mistral-model", "", "Model for Mistral")
+	ApiKey   string `yaml:"api-key" usage:"API Key"`
+	Endpoint string `yaml:"endpoint" usage:"Endpoint"`
+	Model    string `yaml:"model" usage:"Model"`
 }
 
 func (c *MistralConfig) AsOptions() (opts []mistral.Option) {

config/llm/ollama.go

@@ -2,18 +2,12 @@ package llm
 
 import (
 	"fmt"
-	flag "github.com/spf13/pflag"
 	"github.com/tmc/langchaingo/llms/ollama"
 )
 
 type OllamaConfig struct {
-	ServerURL string `config:"server-url" usage:"Server URL"`
-	Model     string `config:"model" usage:"Model"`
-}
-
-func configureOllama(c *OllamaConfig) {
-	flag.StringVar(&c.ServerURL, "ollama-server-url", "", "Server URL for Ollama")
-	flag.StringVar(&c.Model, "ollama-model", "", "Model for Ollama")
+	ServerURL string `yaml:"server-url" usage:"Server URL"`
+	Model     string `yaml:"model" usage:"Model"`
 }
 
 func (c *OllamaConfig) AsOptions() (opts []ollama.Option) {

config/llm/openai.go

@@ -2,18 +2,17 @@ package llm
 
 import (
 	"fmt"
-	flag "github.com/spf13/pflag"
 	"github.com/tmc/langchaingo/llms/openai"
 )
 
 type OpenAIConfig struct {
-	APIKey     string `config:"api-key" usage:"API Key"`
-	APIType    string `config:"api-type"`
-	APIVersion string `config:"api-version" usage:"API Version"`
+	APIKey     string `yaml:"api-key" usage:"API Key"`
+	APIType    string `yaml:"api-type"`
+	APIVersion string `yaml:"api-version" usage:"API Version"`
 
-	Model        string `config:"model" usage:"Model"`
-	BaseUrl      string `config:"base-url" usage:"BaseUrl"`
-	Organization string `config:"organization" usage:"Organization"`
+	Model        string `yaml:"model" usage:"Model"`
+	BaseUrl      string `yaml:"base-url" usage:"BaseUrl"`
+	Organization string `yaml:"organization" usage:"Organization"`
 }
 
 func (c *OpenAIConfig) GetUsage(field string) string {
@@ -24,15 +23,6 @@ func (c *OpenAIConfig) GetUsage(field string) string {
 	return ""
 }
 
-func configureOpenai(c *OpenAIConfig) {
-	flag.StringVar(&c.APIKey, "openai-api-key", "", "OpenAI API Key")
-	flag.StringVar(&c.APIType, "openai-api-type", string(openai.APITypeOpenAI), fmt.Sprintf("OpenAI API Type (%s, %s, %s)", openai.APITypeOpenAI, openai.APITypeAzure, openai.APITypeAzureAD))
-	flag.StringVar(&c.APIVersion, "openai-api-version", "", "OpenAI API Version")
-	flag.StringVar(&c.Model, "openai-model", "gpt-4o-mini", "OpenAI chat model")
-	flag.StringVar(&c.BaseUrl, "openai-base-url", "", "OpenAI API Base-URL")
-	flag.StringVar(&c.Organization, "openai-organization", "", "OpenAI Organization")
-}
-
 func (c *OpenAIConfig) AsOptions() (opts []openai.Option) {
 	if c.APIKey != "" {
 		opts = append(opts, openai.WithToken(c.APIKey))