load.go

  1package config
  2
  3import (
  4	"encoding/json"
  5	"fmt"
  6	"io"
  7	"os"
  8	"path/filepath"
  9	"runtime"
 10	"slices"
 11	"strings"
 12
 13	"github.com/charmbracelet/crush/internal/fur/client"
 14	"github.com/charmbracelet/crush/internal/fur/provider"
 15	"github.com/charmbracelet/crush/pkg/env"
 16	"github.com/charmbracelet/crush/pkg/log"
 17	"golang.org/x/exp/slog"
 18)
 19
 20// LoadReader config via io.Reader.
 21func LoadReader(fd io.Reader) (*Config, error) {
 22	data, err := io.ReadAll(fd)
 23	if err != nil {
 24		return nil, err
 25	}
 26
 27	var config Config
 28	err = json.Unmarshal(data, &config)
 29	if err != nil {
 30		return nil, err
 31	}
 32	return &config, err
 33}
 34
 35// Load loads the configuration from the default paths.
 36func Load(workingDir string, debug bool) (*Config, error) {
 37	// uses default config paths
 38	configPaths := []string{
 39		globalConfig(),
 40		globalConfigData(),
 41		filepath.Join(workingDir, fmt.Sprintf("%s.json", appName)),
 42		filepath.Join(workingDir, fmt.Sprintf(".%s.json", appName)),
 43	}
 44	cfg, err := loadFromConfigPaths(configPaths)
 45
 46	if debug {
 47		cfg.Options.Debug = true
 48	}
 49
 50	// Init logs
 51	log.Init(
 52		filepath.Join(cfg.Options.DataDirectory, "logs", fmt.Sprintf("%s.log", appName)),
 53		cfg.Options.Debug,
 54	)
 55
 56	if err != nil {
 57		return nil, fmt.Errorf("failed to load config: %w", err)
 58	}
 59
 60	cfg.setDefaults(workingDir)
 61
 62	// Load known providers, this loads the config from fur
 63	providers, err := LoadProviders(client.New())
 64	if err != nil || len(providers) == 0 {
 65		return nil, fmt.Errorf("failed to load providers: %w", err)
 66	}
 67
 68	env := env.New()
 69	// Configure providers
 70	valueResolver := NewShellVariableResolver(env)
 71	if err := cfg.configureProviders(env, valueResolver, providers); err != nil {
 72		return nil, fmt.Errorf("failed to configure providers: %w", err)
 73	}
 74
 75	if !cfg.IsConfigured() {
 76		slog.Warn("No providers configured")
 77		return cfg, nil
 78	}
 79
 80	if err := cfg.configureSelectedModels(providers); err != nil {
 81		return nil, fmt.Errorf("failed to configure selected models: %w", err)
 82	}
 83
 84	return cfg, nil
 85}
 86
 87func (cfg *Config) configureProviders(env env.Env, resolver VariableResolver, knownProviders []provider.Provider) error {
 88	knownProviderNames := make(map[string]bool)
 89	for _, p := range knownProviders {
 90		knownProviderNames[string(p.ID)] = true
 91		config, configExists := cfg.Providers[string(p.ID)]
 92		// if the user configured a known provider we need to allow it to override a couple of parameters
 93		if configExists {
 94			if config.Disable {
 95				slog.Debug("Skipping provider due to disable flag", "provider", p.ID)
 96				delete(cfg.Providers, string(p.ID))
 97				continue
 98			}
 99			if config.BaseURL != "" {
100				p.APIEndpoint = config.BaseURL
101			}
102			if config.APIKey != "" {
103				p.APIKey = config.APIKey
104			}
105			if len(config.Models) > 0 {
106				models := []provider.Model{}
107				seen := make(map[string]bool)
108
109				for _, model := range config.Models {
110					if seen[model.ID] {
111						continue
112					}
113					seen[model.ID] = true
114					models = append(models, model)
115				}
116				for _, model := range p.Models {
117					if seen[model.ID] {
118						continue
119					}
120					seen[model.ID] = true
121					models = append(models, model)
122				}
123
124				p.Models = models
125			}
126		}
127		prepared := ProviderConfig{
128			ID:           string(p.ID),
129			BaseURL:      p.APIEndpoint,
130			APIKey:       p.APIKey,
131			Type:         p.Type,
132			Disable:      config.Disable,
133			ExtraHeaders: config.ExtraHeaders,
134			ExtraParams:  make(map[string]string),
135			Models:       p.Models,
136		}
137
138		switch p.ID {
139		// Handle specific providers that require additional configuration
140		case provider.InferenceProviderVertexAI:
141			if !hasVertexCredentials(env) {
142				if configExists {
143					slog.Warn("Skipping Vertex AI provider due to missing credentials")
144					delete(cfg.Providers, string(p.ID))
145				}
146				continue
147			}
148			prepared.ExtraParams["project"] = env.Get("GOOGLE_CLOUD_PROJECT")
149			prepared.ExtraParams["location"] = env.Get("GOOGLE_CLOUD_LOCATION")
150		case provider.InferenceProviderBedrock:
151			if !hasAWSCredentials(env) {
152				if configExists {
153					slog.Warn("Skipping Bedrock provider due to missing AWS credentials")
154					delete(cfg.Providers, string(p.ID))
155				}
156				continue
157			}
158			for _, model := range p.Models {
159				if !strings.HasPrefix(model.ID, "anthropic.") {
160					return fmt.Errorf("bedrock provider only supports anthropic models for now, found: %s", model.ID)
161				}
162			}
163		default:
164			// if the provider api or endpoint are missing we skip them
165			v, err := resolver.ResolveValue(p.APIKey)
166			if v == "" || err != nil {
167				if configExists {
168					slog.Warn("Skipping provider due to missing API key", "provider", p.ID)
169					delete(cfg.Providers, string(p.ID))
170				}
171				continue
172			}
173		}
174		cfg.Providers[string(p.ID)] = prepared
175	}
176
177	// validate the custom providers
178	for id, providerConfig := range cfg.Providers {
179		if knownProviderNames[id] {
180			continue
181		}
182
183		// Make sure the provider ID is set
184		providerConfig.ID = id
185		// default to OpenAI if not set
186		if providerConfig.Type == "" {
187			providerConfig.Type = provider.TypeOpenAI
188		}
189
190		if providerConfig.Disable {
191			slog.Debug("Skipping custom provider due to disable flag", "provider", id)
192			delete(cfg.Providers, id)
193			continue
194		}
195		if providerConfig.APIKey == "" {
196			slog.Warn("Skipping custom provider due to missing API key", "provider", id)
197			delete(cfg.Providers, id)
198			continue
199		}
200		if providerConfig.BaseURL == "" {
201			slog.Warn("Skipping custom provider due to missing API endpoint", "provider", id)
202			delete(cfg.Providers, id)
203			continue
204		}
205		if len(providerConfig.Models) == 0 {
206			slog.Warn("Skipping custom provider because the provider has no models", "provider", id)
207			delete(cfg.Providers, id)
208			continue
209		}
210		if providerConfig.Type != provider.TypeOpenAI {
211			slog.Warn("Skipping custom provider because the provider type is not supported", "provider", id, "type", providerConfig.Type)
212			delete(cfg.Providers, id)
213			continue
214		}
215
216		apiKey, err := resolver.ResolveValue(providerConfig.APIKey)
217		if apiKey == "" || err != nil {
218			slog.Warn("Skipping custom provider due to missing API key", "provider", id, "error", err)
219			delete(cfg.Providers, id)
220			continue
221		}
222		baseURL, err := resolver.ResolveValue(providerConfig.BaseURL)
223		if baseURL == "" || err != nil {
224			slog.Warn("Skipping custom provider due to missing API endpoint", "provider", id, "error", err)
225			delete(cfg.Providers, id)
226			continue
227		}
228
229		cfg.Providers[id] = providerConfig
230	}
231	return nil
232}
233
234func (cfg *Config) setDefaults(workingDir string) {
235	cfg.workingDir = workingDir
236	if cfg.Options == nil {
237		cfg.Options = &Options{}
238	}
239	if cfg.Options.TUI == nil {
240		cfg.Options.TUI = &TUIOptions{}
241	}
242	if cfg.Options.ContextPaths == nil {
243		cfg.Options.ContextPaths = []string{}
244	}
245	if cfg.Options.DataDirectory == "" {
246		cfg.Options.DataDirectory = filepath.Join(workingDir, defaultDataDirectory)
247	}
248	if cfg.Providers == nil {
249		cfg.Providers = make(map[string]ProviderConfig)
250	}
251	if cfg.Models == nil {
252		cfg.Models = make(map[SelectedModelType]SelectedModel)
253	}
254	if cfg.MCP == nil {
255		cfg.MCP = make(map[string]MCPConfig)
256	}
257	if cfg.LSP == nil {
258		cfg.LSP = make(map[string]LSPConfig)
259	}
260
261	// Add the default context paths if they are not already present
262	cfg.Options.ContextPaths = append(defaultContextPaths, cfg.Options.ContextPaths...)
263	slices.Sort(cfg.Options.ContextPaths)
264	cfg.Options.ContextPaths = slices.Compact(cfg.Options.ContextPaths)
265}
266
267func (cfg *Config) defaultModelSelection(knownProviders []provider.Provider) (largeModel SelectedModel, smallModel SelectedModel, err error) {
268	if len(knownProviders) == 0 && len(cfg.Providers) == 0 {
269		err = fmt.Errorf("no providers configured, please configure at least one provider")
270		return
271	}
272
273	// Use the first provider enabled based on the known providers order
274	// if no provider found that is known use the first provider configured
275	for _, p := range knownProviders {
276		providerConfig, ok := cfg.Providers[string(p.ID)]
277		if !ok || providerConfig.Disable {
278			continue
279		}
280		defaultLargeModel := cfg.GetModel(string(p.ID), p.DefaultLargeModelID)
281		if defaultLargeModel == nil {
282			err = fmt.Errorf("default large model %s not found for provider %s", p.DefaultLargeModelID, p.ID)
283			return
284		}
285		largeModel = SelectedModel{
286			Provider:  string(p.ID),
287			Model:     defaultLargeModel.ID,
288			MaxTokens: defaultLargeModel.DefaultMaxTokens,
289		}
290
291		defaultSmallModel := cfg.GetModel(string(p.ID), p.DefaultSmallModelID)
292		if defaultSmallModel == nil {
293			err = fmt.Errorf("default small model %s not found for provider %s", p.DefaultSmallModelID, p.ID)
294		}
295		smallModel = SelectedModel{
296			Provider:  string(p.ID),
297			Model:     defaultSmallModel.ID,
298			MaxTokens: defaultSmallModel.DefaultMaxTokens,
299		}
300		return
301	}
302
303	enabledProviders := cfg.EnabledProviders()
304	slices.SortFunc(enabledProviders, func(a, b ProviderConfig) int {
305		return strings.Compare(a.ID, b.ID)
306	})
307
308	if len(enabledProviders) == 0 {
309		err = fmt.Errorf("no providers configured, please configure at least one provider")
310		return
311	}
312
313	providerConfig := enabledProviders[0]
314	if len(providerConfig.Models) == 0 {
315		err = fmt.Errorf("provider %s has no models configured", providerConfig.ID)
316		return
317	}
318	defaultLargeModel := cfg.GetModel(providerConfig.ID, providerConfig.Models[0].ID)
319	largeModel = SelectedModel{
320		Provider:  providerConfig.ID,
321		Model:     defaultLargeModel.ID,
322		MaxTokens: defaultLargeModel.DefaultMaxTokens,
323	}
324	defaultSmallModel := cfg.GetModel(providerConfig.ID, providerConfig.Models[0].ID)
325	smallModel = SelectedModel{
326		Provider:  providerConfig.ID,
327		Model:     defaultSmallModel.ID,
328		MaxTokens: defaultSmallModel.DefaultMaxTokens,
329	}
330	return
331}
332
333func (cfg *Config) configureSelectedModels(knownProviders []provider.Provider) error {
334	large, small, err := cfg.defaultModelSelection(knownProviders)
335	if err != nil {
336		return fmt.Errorf("failed to select default models: %w", err)
337	}
338
339	largeModelSelected, largeModelConfigured := cfg.Models[SelectedModelTypeLarge]
340	if largeModelConfigured {
341		if largeModelSelected.Model != "" {
342			large.Model = largeModelSelected.Model
343		}
344		if largeModelSelected.Provider != "" {
345			large.Provider = largeModelSelected.Provider
346		}
347		model := cfg.GetModel(large.Provider, large.Model)
348		if model == nil {
349			return fmt.Errorf("large model %s not found for provider %s", large.Model, large.Provider)
350		}
351		if largeModelSelected.MaxTokens > 0 {
352			large.MaxTokens = largeModelSelected.MaxTokens
353		} else {
354			large.MaxTokens = model.DefaultMaxTokens
355		}
356		large.ReasoningEffort = largeModelSelected.ReasoningEffort
357		large.Think = largeModelSelected.Think
358
359	}
360	smallModelSelected, smallModelConfigured := cfg.Models[SelectedModelTypeSmall]
361	if smallModelConfigured {
362		if smallModelSelected.Model != "" {
363			small.Model = smallModelSelected.Model
364		}
365		if smallModelSelected.Provider != "" {
366			small.Provider = smallModelSelected.Provider
367		}
368
369		model := cfg.GetModel(small.Provider, small.Model)
370		if model == nil {
371			return fmt.Errorf("large model %s not found for provider %s", large.Model, large.Provider)
372		}
373		if smallModelSelected.MaxTokens > 0 {
374			small.MaxTokens = smallModelSelected.MaxTokens
375		} else {
376			small.MaxTokens = model.DefaultMaxTokens
377		}
378		small.ReasoningEffort = smallModelSelected.ReasoningEffort
379		small.Think = smallModelSelected.Think
380	}
381
382	// validate the selected models
383	largeModel := cfg.GetModel(large.Provider, large.Model)
384	if largeModel == nil {
385		return fmt.Errorf("large model %s not found for provider %s", large.Model, large.Provider)
386	}
387	smallModel := cfg.GetModel(small.Provider, small.Model)
388	if smallModel == nil {
389		return fmt.Errorf("small model %s not found for provider %s", small.Model, small.Provider)
390	}
391	cfg.Models[SelectedModelTypeLarge] = large
392	cfg.Models[SelectedModelTypeSmall] = small
393	return nil
394}
395
396func loadFromConfigPaths(configPaths []string) (*Config, error) {
397	var configs []io.Reader
398
399	for _, path := range configPaths {
400		fd, err := os.Open(path)
401		if err != nil {
402			if os.IsNotExist(err) {
403				continue
404			}
405			return nil, fmt.Errorf("failed to open config file %s: %w", path, err)
406		}
407		defer fd.Close()
408
409		configs = append(configs, fd)
410	}
411
412	return loadFromReaders(configs)
413}
414
415func loadFromReaders(readers []io.Reader) (*Config, error) {
416	if len(readers) == 0 {
417		return nil, fmt.Errorf("no configuration readers provided")
418	}
419
420	merged, err := Merge(readers)
421	if err != nil {
422		return nil, fmt.Errorf("failed to merge configuration readers: %w", err)
423	}
424
425	return LoadReader(merged)
426}
427
428func hasVertexCredentials(env env.Env) bool {
429	useVertex := env.Get("GOOGLE_GENAI_USE_VERTEXAI") == "true"
430	hasProject := env.Get("GOOGLE_CLOUD_PROJECT") != ""
431	hasLocation := env.Get("GOOGLE_CLOUD_LOCATION") != ""
432	return useVertex && hasProject && hasLocation
433}
434
435func hasAWSCredentials(env env.Env) bool {
436	if env.Get("AWS_ACCESS_KEY_ID") != "" && env.Get("AWS_SECRET_ACCESS_KEY") != "" {
437		return true
438	}
439
440	if env.Get("AWS_PROFILE") != "" || env.Get("AWS_DEFAULT_PROFILE") != "" {
441		return true
442	}
443
444	if env.Get("AWS_REGION") != "" || env.Get("AWS_DEFAULT_REGION") != "" {
445		return true
446	}
447
448	if env.Get("AWS_CONTAINER_CREDENTIALS_RELATIVE_URI") != "" ||
449		env.Get("AWS_CONTAINER_CREDENTIALS_FULL_URI") != "" {
450		return true
451	}
452
453	return false
454}
455
456func globalConfig() string {
457	xdgConfigHome := os.Getenv("XDG_CONFIG_HOME")
458	if xdgConfigHome != "" {
459		return filepath.Join(xdgConfigHome, "crush")
460	}
461
462	// return the path to the main config directory
463	// for windows, it should be in `%LOCALAPPDATA%/crush/`
464	// for linux and macOS, it should be in `$HOME/.config/crush/`
465	if runtime.GOOS == "windows" {
466		localAppData := os.Getenv("LOCALAPPDATA")
467		if localAppData == "" {
468			localAppData = filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local")
469		}
470		return filepath.Join(localAppData, appName)
471	}
472
473	return filepath.Join(os.Getenv("HOME"), ".config", appName, fmt.Sprintf("%s.json", appName))
474}
475
476// globalConfigData returns the path to the main data directory for the application.
477// this config is used when the app overrides configurations instead of updating the global config.
478func globalConfigData() string {
479	xdgDataHome := os.Getenv("XDG_DATA_HOME")
480	if xdgDataHome != "" {
481		return filepath.Join(xdgDataHome, appName)
482	}
483
484	// return the path to the main data directory
485	// for windows, it should be in `%LOCALAPPDATA%/crush/`
486	// for linux and macOS, it should be in `$HOME/.local/share/crush/`
487	if runtime.GOOS == "windows" {
488		localAppData := os.Getenv("LOCALAPPDATA")
489		if localAppData == "" {
490			localAppData = filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local")
491		}
492		return filepath.Join(localAppData, appName)
493	}
494
495	return filepath.Join(os.Getenv("HOME"), ".local", "share", appName, fmt.Sprintf("%s.json", appName))
496}