load.go

  1package config
  2
  3import (
  4	"encoding/json"
  5	"fmt"
  6	"io"
  7	"log/slog"
  8	"maps"
  9	"os"
 10	"path/filepath"
 11	"runtime"
 12	"slices"
 13	"strconv"
 14	"strings"
 15
 16	"github.com/charmbracelet/catwalk/pkg/catwalk"
 17	"github.com/charmbracelet/crush/internal/csync"
 18	"github.com/charmbracelet/crush/internal/env"
 19	"github.com/charmbracelet/crush/internal/fsext"
 20	"github.com/charmbracelet/crush/internal/home"
 21	"github.com/charmbracelet/crush/internal/log"
 22	powernapConfig "github.com/charmbracelet/x/powernap/pkg/config"
 23)
 24
 25const defaultCatwalkURL = "https://catwalk.charm.sh"
 26
 27// LoadReader config via io.Reader.
 28func LoadReader(fd io.Reader) (*Config, error) {
 29	data, err := io.ReadAll(fd)
 30	if err != nil {
 31		return nil, err
 32	}
 33
 34	var config Config
 35	err = json.Unmarshal(data, &config)
 36	if err != nil {
 37		return nil, err
 38	}
 39	return &config, err
 40}
 41
 42// Load loads the configuration from the default paths.
 43func Load(workingDir, dataDir string, debug bool) (*Config, error) {
 44	// uses default config paths
 45	configPaths := []string{
 46		globalConfig(),
 47		GlobalConfigData(),
 48		filepath.Join(workingDir, fmt.Sprintf("%s.json", appName)),
 49		filepath.Join(workingDir, fmt.Sprintf(".%s.json", appName)),
 50	}
 51	cfg, err := loadFromConfigPaths(configPaths)
 52	if err != nil {
 53		return nil, fmt.Errorf("failed to load config from paths %v: %w", configPaths, err)
 54	}
 55
 56	cfg.dataConfigDir = GlobalConfigData()
 57
 58	cfg.setDefaults(workingDir, dataDir)
 59
 60	if debug {
 61		cfg.Options.Debug = true
 62	}
 63
 64	// Setup logs
 65	log.Setup(
 66		filepath.Join(cfg.Options.DataDirectory, "logs", fmt.Sprintf("%s.log", appName)),
 67		cfg.Options.Debug,
 68	)
 69
 70	// Load known providers, this loads the config from catwalk
 71	providers, err := Providers(cfg)
 72	if err != nil {
 73		return nil, err
 74	}
 75	cfg.knownProviders = providers
 76
 77	env := env.New()
 78	// Configure providers
 79	valueResolver := NewShellVariableResolver(env)
 80	cfg.resolver = valueResolver
 81	if err := cfg.configureProviders(env, valueResolver, cfg.knownProviders); err != nil {
 82		return nil, fmt.Errorf("failed to configure providers: %w", err)
 83	}
 84
 85	if !cfg.IsConfigured() {
 86		slog.Warn("No providers configured")
 87		return cfg, nil
 88	}
 89
 90	if err := cfg.configureSelectedModels(cfg.knownProviders); err != nil {
 91		return nil, fmt.Errorf("failed to configure selected models: %w", err)
 92	}
 93	cfg.SetupAgents()
 94	return cfg, nil
 95}
 96
 97func PushPopCrushEnv() func() {
 98	found := []string{}
 99	for _, ev := range os.Environ() {
100		if strings.HasPrefix(ev, "CRUSH_") {
101			pair := strings.SplitN(ev, "=", 2)
102			if len(pair) != 2 {
103				continue
104			}
105			found = append(found, strings.TrimPrefix(pair[0], "CRUSH_"))
106		}
107	}
108	backups := make(map[string]string)
109	for _, ev := range found {
110		backups[ev] = os.Getenv(ev)
111	}
112
113	for _, ev := range found {
114		os.Setenv(ev, os.Getenv("CRUSH_"+ev))
115	}
116
117	restore := func() {
118		for k, v := range backups {
119			os.Setenv(k, v)
120		}
121	}
122	return restore
123}
124
125func (c *Config) configureProviders(env env.Env, resolver VariableResolver, knownProviders []catwalk.Provider) error {
126	knownProviderNames := make(map[string]bool)
127	restore := PushPopCrushEnv()
128	defer restore()
129	for _, p := range knownProviders {
130		knownProviderNames[string(p.ID)] = true
131		config, configExists := c.Providers.Get(string(p.ID))
132		// if the user configured a known provider we need to allow it to override a couple of parameters
133		if configExists {
134			if config.Disable {
135				slog.Debug("Skipping provider due to disable flag", "provider", p.ID)
136				c.Providers.Del(string(p.ID))
137				continue
138			}
139			if config.BaseURL != "" {
140				p.APIEndpoint = config.BaseURL
141			}
142			if config.APIKey != "" {
143				p.APIKey = config.APIKey
144			}
145			if len(config.Models) > 0 {
146				models := []catwalk.Model{}
147				seen := make(map[string]bool)
148
149				for _, model := range config.Models {
150					if seen[model.ID] {
151						continue
152					}
153					seen[model.ID] = true
154					if model.Name == "" {
155						model.Name = model.ID
156					}
157					models = append(models, model)
158				}
159				for _, model := range p.Models {
160					if seen[model.ID] {
161						continue
162					}
163					seen[model.ID] = true
164					if model.Name == "" {
165						model.Name = model.ID
166					}
167					models = append(models, model)
168				}
169
170				p.Models = models
171			}
172		}
173
174		headers := map[string]string{}
175		if len(p.DefaultHeaders) > 0 {
176			maps.Copy(headers, p.DefaultHeaders)
177		}
178		if len(config.ExtraHeaders) > 0 {
179			maps.Copy(headers, config.ExtraHeaders)
180		}
181		prepared := ProviderConfig{
182			ID:                 string(p.ID),
183			Name:               p.Name,
184			BaseURL:            p.APIEndpoint,
185			APIKey:             p.APIKey,
186			Type:               p.Type,
187			Disable:            config.Disable,
188			SystemPromptPrefix: config.SystemPromptPrefix,
189			ExtraHeaders:       headers,
190			ExtraBody:          config.ExtraBody,
191			ExtraParams:        make(map[string]string),
192			Models:             p.Models,
193		}
194
195		switch p.ID {
196		// Handle specific providers that require additional configuration
197		case catwalk.InferenceProviderVertexAI:
198			if !hasVertexCredentials(env) {
199				if configExists {
200					slog.Warn("Skipping Vertex AI provider due to missing credentials")
201					c.Providers.Del(string(p.ID))
202				}
203				continue
204			}
205			prepared.ExtraParams["project"] = env.Get("VERTEXAI_PROJECT")
206			prepared.ExtraParams["location"] = env.Get("VERTEXAI_LOCATION")
207		case catwalk.InferenceProviderAzure:
208			endpoint, err := resolver.ResolveValue(p.APIEndpoint)
209			if err != nil || endpoint == "" {
210				if configExists {
211					slog.Warn("Skipping Azure provider due to missing API endpoint", "provider", p.ID, "error", err)
212					c.Providers.Del(string(p.ID))
213				}
214				continue
215			}
216			prepared.BaseURL = endpoint
217			prepared.ExtraParams["apiVersion"] = env.Get("AZURE_OPENAI_API_VERSION")
218		case catwalk.InferenceProviderBedrock:
219			if !hasAWSCredentials(env) {
220				if configExists {
221					slog.Warn("Skipping Bedrock provider due to missing AWS credentials")
222					c.Providers.Del(string(p.ID))
223				}
224				continue
225			}
226			prepared.ExtraParams["region"] = env.Get("AWS_REGION")
227			if prepared.ExtraParams["region"] == "" {
228				prepared.ExtraParams["region"] = env.Get("AWS_DEFAULT_REGION")
229			}
230			for _, model := range p.Models {
231				if !strings.HasPrefix(model.ID, "anthropic.") {
232					return fmt.Errorf("bedrock provider only supports anthropic models for now, found: %s", model.ID)
233				}
234			}
235		default:
236			// if the provider api or endpoint are missing we skip them
237			v, err := resolver.ResolveValue(p.APIKey)
238			if v == "" || err != nil {
239				if configExists {
240					slog.Warn("Skipping provider due to missing API key", "provider", p.ID)
241					c.Providers.Del(string(p.ID))
242				}
243				continue
244			}
245		}
246		c.Providers.Set(string(p.ID), prepared)
247	}
248
249	// validate the custom providers
250	for id, providerConfig := range c.Providers.Seq2() {
251		if knownProviderNames[id] {
252			continue
253		}
254
255		// Make sure the provider ID is set
256		providerConfig.ID = id
257		if providerConfig.Name == "" {
258			providerConfig.Name = id // Use ID as name if not set
259		}
260		// default to OpenAI if not set
261		if providerConfig.Type == "" {
262			providerConfig.Type = catwalk.TypeOpenAI
263		}
264
265		if providerConfig.Disable {
266			slog.Debug("Skipping custom provider due to disable flag", "provider", id)
267			c.Providers.Del(id)
268			continue
269		}
270		if providerConfig.APIKey == "" {
271			slog.Warn("Provider is missing API key, this might be OK for local providers", "provider", id)
272		}
273		if providerConfig.BaseURL == "" {
274			slog.Warn("Skipping custom provider due to missing API endpoint", "provider", id)
275			c.Providers.Del(id)
276			continue
277		}
278		if len(providerConfig.Models) == 0 {
279			slog.Warn("Skipping custom provider because the provider has no models", "provider", id)
280			c.Providers.Del(id)
281			continue
282		}
283		if providerConfig.Type != catwalk.TypeOpenAI && providerConfig.Type != catwalk.TypeAnthropic {
284			slog.Warn("Skipping custom provider because the provider type is not supported", "provider", id, "type", providerConfig.Type)
285			c.Providers.Del(id)
286			continue
287		}
288
289		apiKey, err := resolver.ResolveValue(providerConfig.APIKey)
290		if apiKey == "" || err != nil {
291			slog.Warn("Provider is missing API key, this might be OK for local providers", "provider", id)
292		}
293		baseURL, err := resolver.ResolveValue(providerConfig.BaseURL)
294		if baseURL == "" || err != nil {
295			slog.Warn("Skipping custom provider due to missing API endpoint", "provider", id, "error", err)
296			c.Providers.Del(id)
297			continue
298		}
299
300		c.Providers.Set(id, providerConfig)
301	}
302	return nil
303}
304
305func (c *Config) setDefaults(workingDir, dataDir string) {
306	c.workingDir = workingDir
307	if c.Options == nil {
308		c.Options = &Options{}
309	}
310	if c.Options.TUI == nil {
311		c.Options.TUI = &TUIOptions{}
312	}
313	if c.Options.ContextPaths == nil {
314		c.Options.ContextPaths = []string{}
315	}
316	if dataDir != "" {
317		c.Options.DataDirectory = dataDir
318	} else if c.Options.DataDirectory == "" {
319		if path, ok := fsext.SearchParent(workingDir, defaultDataDirectory); ok {
320			c.Options.DataDirectory = path
321		} else {
322			c.Options.DataDirectory = filepath.Join(workingDir, defaultDataDirectory)
323		}
324	}
325	if c.Providers == nil {
326		c.Providers = csync.NewMap[string, ProviderConfig]()
327	}
328	if c.Models == nil {
329		c.Models = make(map[SelectedModelType]SelectedModel)
330	}
331	if c.MCP == nil {
332		c.MCP = make(map[string]MCPConfig)
333	}
334	if c.LSP == nil {
335		c.LSP = make(map[string]LSPConfig)
336	}
337
338	// Apply defaults to LSP configurations
339	c.applyLSPDefaults()
340
341	// Add the default context paths if they are not already present
342	c.Options.ContextPaths = append(defaultContextPaths, c.Options.ContextPaths...)
343	slices.Sort(c.Options.ContextPaths)
344	c.Options.ContextPaths = slices.Compact(c.Options.ContextPaths)
345
346	if str, ok := os.LookupEnv("CRUSH_DISABLE_PROVIDER_AUTO_UPDATE"); ok {
347		c.Options.DisableProviderAutoUpdate, _ = strconv.ParseBool(str)
348	}
349}
350
351// applyLSPDefaults applies default values from powernap to LSP configurations
352func (c *Config) applyLSPDefaults() {
353	// Get powernap's default configuration
354	configManager := powernapConfig.NewManager()
355	configManager.LoadDefaults()
356
357	// Apply defaults to each LSP configuration
358	for name, cfg := range c.LSP {
359		// Try to get defaults from powernap based on command name
360		base, ok := configManager.GetServer(cfg.Command)
361		if !ok {
362			continue
363		}
364		if cfg.Options == nil {
365			cfg.Options = base.Settings
366		}
367		if cfg.InitOptions == nil {
368			cfg.InitOptions = base.InitOptions
369		}
370		if len(cfg.FileTypes) == 0 {
371			cfg.FileTypes = base.FileTypes
372		}
373		if len(cfg.RootMarkers) == 0 {
374			cfg.RootMarkers = base.RootMarkers
375		}
376		// Update the config in the map
377		c.LSP[name] = cfg
378	}
379}
380
381func (c *Config) defaultModelSelection(knownProviders []catwalk.Provider) (largeModel SelectedModel, smallModel SelectedModel, err error) {
382	if len(knownProviders) == 0 && c.Providers.Len() == 0 {
383		err = fmt.Errorf("no providers configured, please configure at least one provider")
384		return
385	}
386
387	// Use the first provider enabled based on the known providers order
388	// if no provider found that is known use the first provider configured
389	for _, p := range knownProviders {
390		providerConfig, ok := c.Providers.Get(string(p.ID))
391		if !ok || providerConfig.Disable {
392			continue
393		}
394		defaultLargeModel := c.GetModel(string(p.ID), p.DefaultLargeModelID)
395		if defaultLargeModel == nil {
396			err = fmt.Errorf("default large model %s not found for provider %s", p.DefaultLargeModelID, p.ID)
397			return
398		}
399		largeModel = SelectedModel{
400			Provider:        string(p.ID),
401			Model:           defaultLargeModel.ID,
402			MaxTokens:       defaultLargeModel.DefaultMaxTokens,
403			ReasoningEffort: defaultLargeModel.DefaultReasoningEffort,
404		}
405
406		defaultSmallModel := c.GetModel(string(p.ID), p.DefaultSmallModelID)
407		if defaultSmallModel == nil {
408			err = fmt.Errorf("default small model %s not found for provider %s", p.DefaultSmallModelID, p.ID)
409			return
410		}
411		smallModel = SelectedModel{
412			Provider:        string(p.ID),
413			Model:           defaultSmallModel.ID,
414			MaxTokens:       defaultSmallModel.DefaultMaxTokens,
415			ReasoningEffort: defaultSmallModel.DefaultReasoningEffort,
416		}
417		return
418	}
419
420	enabledProviders := c.EnabledProviders()
421	slices.SortFunc(enabledProviders, func(a, b ProviderConfig) int {
422		return strings.Compare(a.ID, b.ID)
423	})
424
425	if len(enabledProviders) == 0 {
426		err = fmt.Errorf("no providers configured, please configure at least one provider")
427		return
428	}
429
430	providerConfig := enabledProviders[0]
431	if len(providerConfig.Models) == 0 {
432		err = fmt.Errorf("provider %s has no models configured", providerConfig.ID)
433		return
434	}
435	defaultLargeModel := c.GetModel(providerConfig.ID, providerConfig.Models[0].ID)
436	largeModel = SelectedModel{
437		Provider:  providerConfig.ID,
438		Model:     defaultLargeModel.ID,
439		MaxTokens: defaultLargeModel.DefaultMaxTokens,
440	}
441	defaultSmallModel := c.GetModel(providerConfig.ID, providerConfig.Models[0].ID)
442	smallModel = SelectedModel{
443		Provider:  providerConfig.ID,
444		Model:     defaultSmallModel.ID,
445		MaxTokens: defaultSmallModel.DefaultMaxTokens,
446	}
447	return
448}
449
450func (c *Config) configureSelectedModels(knownProviders []catwalk.Provider) error {
451	defaultLarge, defaultSmall, err := c.defaultModelSelection(knownProviders)
452	if err != nil {
453		return fmt.Errorf("failed to select default models: %w", err)
454	}
455	large, small := defaultLarge, defaultSmall
456
457	largeModelSelected, largeModelConfigured := c.Models[SelectedModelTypeLarge]
458	if largeModelConfigured {
459		if largeModelSelected.Model != "" {
460			large.Model = largeModelSelected.Model
461		}
462		if largeModelSelected.Provider != "" {
463			large.Provider = largeModelSelected.Provider
464		}
465		model := c.GetModel(large.Provider, large.Model)
466		if model == nil {
467			large = defaultLarge
468			// override the model type to large
469			err := c.UpdatePreferredModel(SelectedModelTypeLarge, large)
470			if err != nil {
471				return fmt.Errorf("failed to update preferred large model: %w", err)
472			}
473		} else {
474			if largeModelSelected.MaxTokens > 0 {
475				large.MaxTokens = largeModelSelected.MaxTokens
476			} else {
477				large.MaxTokens = model.DefaultMaxTokens
478			}
479			if largeModelSelected.ReasoningEffort != "" {
480				large.ReasoningEffort = largeModelSelected.ReasoningEffort
481			}
482			large.Think = largeModelSelected.Think
483		}
484	}
485	smallModelSelected, smallModelConfigured := c.Models[SelectedModelTypeSmall]
486	if smallModelConfigured {
487		if smallModelSelected.Model != "" {
488			small.Model = smallModelSelected.Model
489		}
490		if smallModelSelected.Provider != "" {
491			small.Provider = smallModelSelected.Provider
492		}
493
494		model := c.GetModel(small.Provider, small.Model)
495		if model == nil {
496			small = defaultSmall
497			// override the model type to small
498			err := c.UpdatePreferredModel(SelectedModelTypeSmall, small)
499			if err != nil {
500				return fmt.Errorf("failed to update preferred small model: %w", err)
501			}
502		} else {
503			if smallModelSelected.MaxTokens > 0 {
504				small.MaxTokens = smallModelSelected.MaxTokens
505			} else {
506				small.MaxTokens = model.DefaultMaxTokens
507			}
508			small.ReasoningEffort = smallModelSelected.ReasoningEffort
509			small.Think = smallModelSelected.Think
510		}
511	}
512	c.Models[SelectedModelTypeLarge] = large
513	c.Models[SelectedModelTypeSmall] = small
514	return nil
515}
516
517func loadFromConfigPaths(configPaths []string) (*Config, error) {
518	var configs []io.Reader
519
520	for _, path := range configPaths {
521		fd, err := os.Open(path)
522		if err != nil {
523			if os.IsNotExist(err) {
524				continue
525			}
526			return nil, fmt.Errorf("failed to open config file %s: %w", path, err)
527		}
528		defer fd.Close()
529
530		configs = append(configs, fd)
531	}
532
533	return loadFromReaders(configs)
534}
535
536func loadFromReaders(readers []io.Reader) (*Config, error) {
537	if len(readers) == 0 {
538		return &Config{}, nil
539	}
540
541	merged, err := Merge(readers)
542	if err != nil {
543		return nil, fmt.Errorf("failed to merge configuration readers: %w", err)
544	}
545
546	return LoadReader(merged)
547}
548
549func hasVertexCredentials(env env.Env) bool {
550	hasProject := env.Get("VERTEXAI_PROJECT") != ""
551	hasLocation := env.Get("VERTEXAI_LOCATION") != ""
552	return hasProject && hasLocation
553}
554
555func hasAWSCredentials(env env.Env) bool {
556	if env.Get("AWS_ACCESS_KEY_ID") != "" && env.Get("AWS_SECRET_ACCESS_KEY") != "" {
557		return true
558	}
559
560	if env.Get("AWS_PROFILE") != "" || env.Get("AWS_DEFAULT_PROFILE") != "" {
561		return true
562	}
563
564	if env.Get("AWS_REGION") != "" || env.Get("AWS_DEFAULT_REGION") != "" {
565		return true
566	}
567
568	if env.Get("AWS_CONTAINER_CREDENTIALS_RELATIVE_URI") != "" ||
569		env.Get("AWS_CONTAINER_CREDENTIALS_FULL_URI") != "" {
570		return true
571	}
572	return false
573}
574
575func globalConfig() string {
576	xdgConfigHome := os.Getenv("XDG_CONFIG_HOME")
577	if xdgConfigHome != "" {
578		return filepath.Join(xdgConfigHome, appName, fmt.Sprintf("%s.json", appName))
579	}
580
581	// return the path to the main config directory
582	// for windows, it should be in `%LOCALAPPDATA%/crush/`
583	// for linux and macOS, it should be in `$HOME/.config/crush/`
584	if runtime.GOOS == "windows" {
585		localAppData := os.Getenv("LOCALAPPDATA")
586		if localAppData == "" {
587			localAppData = filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local")
588		}
589		return filepath.Join(localAppData, appName, fmt.Sprintf("%s.json", appName))
590	}
591
592	return filepath.Join(home.Dir(), ".config", appName, fmt.Sprintf("%s.json", appName))
593}
594
595// GlobalConfigData returns the path to the main data directory for the application.
596// this config is used when the app overrides configurations instead of updating the global config.
597func GlobalConfigData() string {
598	xdgDataHome := os.Getenv("XDG_DATA_HOME")
599	if xdgDataHome != "" {
600		return filepath.Join(xdgDataHome, appName, fmt.Sprintf("%s.json", appName))
601	}
602
603	// return the path to the main data directory
604	// for windows, it should be in `%LOCALAPPDATA%/crush/`
605	// for linux and macOS, it should be in `$HOME/.local/share/crush/`
606	if runtime.GOOS == "windows" {
607		localAppData := os.Getenv("LOCALAPPDATA")
608		if localAppData == "" {
609			localAppData = filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local")
610		}
611		return filepath.Join(localAppData, appName, fmt.Sprintf("%s.json", appName))
612	}
613
614	return filepath.Join(home.Dir(), ".local", "share", appName, fmt.Sprintf("%s.json", appName))
615}