load.go

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