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