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
353// applyLSPDefaults applies default values from powernap to LSP configurations
354func (c *Config) applyLSPDefaults() {
355	// Get powernap's default configuration
356	configManager := powernapConfig.NewManager()
357	configManager.LoadDefaults()
358
359	// Apply defaults to each LSP configuration
360	for name, cfg := range c.LSP {
361		// Try to get defaults from powernap based on name or command name.
362		base, ok := configManager.GetServer(name)
363		if !ok {
364			base, ok = configManager.GetServer(cfg.Command)
365			if !ok {
366				continue
367			}
368		}
369		if cfg.Options == nil {
370			cfg.Options = base.Settings
371		}
372		if cfg.InitOptions == nil {
373			cfg.InitOptions = base.InitOptions
374		}
375		if len(cfg.FileTypes) == 0 {
376			cfg.FileTypes = base.FileTypes
377		}
378		if len(cfg.RootMarkers) == 0 {
379			cfg.RootMarkers = base.RootMarkers
380		}
381		if cfg.Command == "" {
382			cfg.Command = base.Command
383		}
384		if len(cfg.Args) == 0 {
385			cfg.Args = base.Args
386		}
387		if len(cfg.Env) == 0 {
388			cfg.Env = base.Environment
389		}
390		// Update the config in the map
391		c.LSP[name] = cfg
392	}
393}
394
395func (c *Config) defaultModelSelection(knownProviders []catwalk.Provider) (largeModel SelectedModel, smallModel SelectedModel, err error) {
396	if len(knownProviders) == 0 && c.Providers.Len() == 0 {
397		err = fmt.Errorf("no providers configured, please configure at least one provider")
398		return largeModel, smallModel, err
399	}
400
401	// Use the first provider enabled based on the known providers order
402	// if no provider found that is known use the first provider configured
403	for _, p := range knownProviders {
404		providerConfig, ok := c.Providers.Get(string(p.ID))
405		if !ok || providerConfig.Disable {
406			continue
407		}
408		defaultLargeModel := c.GetModel(string(p.ID), p.DefaultLargeModelID)
409		if defaultLargeModel == nil {
410			err = fmt.Errorf("default large model %s not found for provider %s", p.DefaultLargeModelID, p.ID)
411			return largeModel, smallModel, err
412		}
413		largeModel = SelectedModel{
414			Provider:        string(p.ID),
415			Model:           defaultLargeModel.ID,
416			MaxTokens:       defaultLargeModel.DefaultMaxTokens,
417			ReasoningEffort: defaultLargeModel.DefaultReasoningEffort,
418		}
419
420		defaultSmallModel := c.GetModel(string(p.ID), p.DefaultSmallModelID)
421		if defaultSmallModel == nil {
422			err = fmt.Errorf("default small model %s not found for provider %s", p.DefaultSmallModelID, p.ID)
423			return largeModel, smallModel, err
424		}
425		smallModel = SelectedModel{
426			Provider:        string(p.ID),
427			Model:           defaultSmallModel.ID,
428			MaxTokens:       defaultSmallModel.DefaultMaxTokens,
429			ReasoningEffort: defaultSmallModel.DefaultReasoningEffort,
430		}
431		return largeModel, smallModel, err
432	}
433
434	enabledProviders := c.EnabledProviders()
435	slices.SortFunc(enabledProviders, func(a, b ProviderConfig) int {
436		return strings.Compare(a.ID, b.ID)
437	})
438
439	if len(enabledProviders) == 0 {
440		err = fmt.Errorf("no providers configured, please configure at least one provider")
441		return largeModel, smallModel, err
442	}
443
444	providerConfig := enabledProviders[0]
445	if len(providerConfig.Models) == 0 {
446		err = fmt.Errorf("provider %s has no models configured", providerConfig.ID)
447		return largeModel, smallModel, err
448	}
449	defaultLargeModel := c.GetModel(providerConfig.ID, providerConfig.Models[0].ID)
450	largeModel = SelectedModel{
451		Provider:  providerConfig.ID,
452		Model:     defaultLargeModel.ID,
453		MaxTokens: defaultLargeModel.DefaultMaxTokens,
454	}
455	defaultSmallModel := c.GetModel(providerConfig.ID, providerConfig.Models[0].ID)
456	smallModel = SelectedModel{
457		Provider:  providerConfig.ID,
458		Model:     defaultSmallModel.ID,
459		MaxTokens: defaultSmallModel.DefaultMaxTokens,
460	}
461	return largeModel, smallModel, err
462}
463
464func (c *Config) configureSelectedModels(knownProviders []catwalk.Provider) error {
465	defaultLarge, defaultSmall, err := c.defaultModelSelection(knownProviders)
466	if err != nil {
467		return fmt.Errorf("failed to select default models: %w", err)
468	}
469	large, small := defaultLarge, defaultSmall
470
471	largeModelSelected, largeModelConfigured := c.Models[SelectedModelTypeLarge]
472	if largeModelConfigured {
473		if largeModelSelected.Model != "" {
474			large.Model = largeModelSelected.Model
475		}
476		if largeModelSelected.Provider != "" {
477			large.Provider = largeModelSelected.Provider
478		}
479		model := c.GetModel(large.Provider, large.Model)
480		if model == nil {
481			large = defaultLarge
482			// override the model type to large
483			err := c.UpdatePreferredModel(SelectedModelTypeLarge, large)
484			if err != nil {
485				return fmt.Errorf("failed to update preferred large model: %w", err)
486			}
487		} else {
488			if largeModelSelected.MaxTokens > 0 {
489				large.MaxTokens = largeModelSelected.MaxTokens
490			} else {
491				large.MaxTokens = model.DefaultMaxTokens
492			}
493			if largeModelSelected.ReasoningEffort != "" {
494				large.ReasoningEffort = largeModelSelected.ReasoningEffort
495			}
496			large.Think = largeModelSelected.Think
497		}
498	}
499	smallModelSelected, smallModelConfigured := c.Models[SelectedModelTypeSmall]
500	if smallModelConfigured {
501		if smallModelSelected.Model != "" {
502			small.Model = smallModelSelected.Model
503		}
504		if smallModelSelected.Provider != "" {
505			small.Provider = smallModelSelected.Provider
506		}
507
508		model := c.GetModel(small.Provider, small.Model)
509		if model == nil {
510			small = defaultSmall
511			// override the model type to small
512			err := c.UpdatePreferredModel(SelectedModelTypeSmall, small)
513			if err != nil {
514				return fmt.Errorf("failed to update preferred small model: %w", err)
515			}
516		} else {
517			if smallModelSelected.MaxTokens > 0 {
518				small.MaxTokens = smallModelSelected.MaxTokens
519			} else {
520				small.MaxTokens = model.DefaultMaxTokens
521			}
522			small.ReasoningEffort = smallModelSelected.ReasoningEffort
523			small.Think = smallModelSelected.Think
524		}
525	}
526	c.Models[SelectedModelTypeLarge] = large
527	c.Models[SelectedModelTypeSmall] = small
528	return nil
529}
530
531// lookupConfigs searches config files recursively from CWD up to FS root
532func lookupConfigs(cwd string) []string {
533	// prepend default config paths
534	configPaths := []string{
535		GlobalConfig(),
536		GlobalConfigData(),
537	}
538
539	configNames := []string{appName + ".json", "." + appName + ".json"}
540
541	foundConfigs, err := fsext.Lookup(cwd, configNames...)
542	if err != nil {
543		// returns at least default configs
544		return configPaths
545	}
546
547	// reverse order so last config has more priority
548	slices.Reverse(foundConfigs)
549
550	return append(configPaths, foundConfigs...)
551}
552
553func loadFromConfigPaths(configPaths []string) (*Config, error) {
554	var configs []io.Reader
555
556	for _, path := range configPaths {
557		fd, err := os.Open(path)
558		if err != nil {
559			if os.IsNotExist(err) {
560				continue
561			}
562			return nil, fmt.Errorf("failed to open config file %s: %w", path, err)
563		}
564		defer fd.Close()
565
566		configs = append(configs, fd)
567	}
568
569	return loadFromReaders(configs)
570}
571
572func loadFromReaders(readers []io.Reader) (*Config, error) {
573	if len(readers) == 0 {
574		return &Config{}, nil
575	}
576
577	merged, err := Merge(readers)
578	if err != nil {
579		return nil, fmt.Errorf("failed to merge configuration readers: %w", err)
580	}
581
582	return LoadReader(merged)
583}
584
585func hasVertexCredentials(env env.Env) bool {
586	hasProject := env.Get("VERTEXAI_PROJECT") != ""
587	hasLocation := env.Get("VERTEXAI_LOCATION") != ""
588	return hasProject && hasLocation
589}
590
591func hasAWSCredentials(env env.Env) bool {
592	if env.Get("AWS_BEARER_TOKEN_BEDROCK") != "" {
593		return true
594	}
595
596	if env.Get("AWS_ACCESS_KEY_ID") != "" && env.Get("AWS_SECRET_ACCESS_KEY") != "" {
597		return true
598	}
599
600	if env.Get("AWS_PROFILE") != "" || env.Get("AWS_DEFAULT_PROFILE") != "" {
601		return true
602	}
603
604	if env.Get("AWS_REGION") != "" || env.Get("AWS_DEFAULT_REGION") != "" {
605		return true
606	}
607
608	if env.Get("AWS_CONTAINER_CREDENTIALS_RELATIVE_URI") != "" ||
609		env.Get("AWS_CONTAINER_CREDENTIALS_FULL_URI") != "" {
610		return true
611	}
612
613	if _, err := os.Stat(filepath.Join(home.Dir(), ".aws/credentials")); err == nil {
614		return true
615	}
616
617	return false
618}
619
620// GlobalConfig returns the global configuration file path for the application.
621func GlobalConfig() string {
622	xdgConfigHome := os.Getenv("XDG_CONFIG_HOME")
623	if xdgConfigHome != "" {
624		return filepath.Join(xdgConfigHome, appName, fmt.Sprintf("%s.json", appName))
625	}
626
627	// return the path to the main config directory
628	// for windows, it should be in `%LOCALAPPDATA%/crush/`
629	// for linux and macOS, it should be in `$HOME/.config/crush/`
630	if runtime.GOOS == "windows" {
631		localAppData := os.Getenv("LOCALAPPDATA")
632		if localAppData == "" {
633			localAppData = filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local")
634		}
635		return filepath.Join(localAppData, appName, fmt.Sprintf("%s.json", appName))
636	}
637
638	return filepath.Join(home.Dir(), ".config", appName, fmt.Sprintf("%s.json", appName))
639}
640
641// GlobalConfigData returns the path to the main data directory for the application.
642// this config is used when the app overrides configurations instead of updating the global config.
643func GlobalConfigData() string {
644	xdgDataHome := os.Getenv("XDG_DATA_HOME")
645	if xdgDataHome != "" {
646		return filepath.Join(xdgDataHome, appName, fmt.Sprintf("%s.json", appName))
647	}
648
649	// return the path to the main data directory
650	// for windows, it should be in `%LOCALAPPDATA%/crush/`
651	// for linux and macOS, it should be in `$HOME/.local/share/crush/`
652	if runtime.GOOS == "windows" {
653		localAppData := os.Getenv("LOCALAPPDATA")
654		if localAppData == "" {
655			localAppData = filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local")
656		}
657		return filepath.Join(localAppData, appName, fmt.Sprintf("%s.json", appName))
658	}
659
660	return filepath.Join(home.Dir(), ".local", "share", appName, fmt.Sprintf("%s.json", appName))
661}
662
663func assignIfNil[T any](ptr **T, val T) {
664	if *ptr == nil {
665		*ptr = &val
666	}
667}
668
669func isInsideWorktree() bool {
670	bts, err := exec.CommandContext(
671		context.Background(),
672		"git", "rev-parse",
673		"--is-inside-work-tree",
674	).CombinedOutput()
675	return err == nil && strings.TrimSpace(string(bts)) == "true"
676}