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