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