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