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