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