load.go

  1package config
  2
  3import (
  4	"encoding/json"
  5	"fmt"
  6	"io"
  7	"os"
  8	"path/filepath"
  9	"runtime"
 10	"slices"
 11	"strings"
 12
 13	"github.com/charmbracelet/crush/internal/env"
 14	"github.com/charmbracelet/crush/internal/fur/client"
 15	"github.com/charmbracelet/crush/internal/fur/provider"
 16	"github.com/charmbracelet/crush/internal/log"
 17	"golang.org/x/exp/slog"
 18)
 19
 20// LoadReader config via io.Reader.
 21func LoadReader(fd io.Reader) (*Config, error) {
 22	data, err := io.ReadAll(fd)
 23	if err != nil {
 24		return nil, err
 25	}
 26
 27	var config Config
 28	err = json.Unmarshal(data, &config)
 29	if err != nil {
 30		return nil, err
 31	}
 32	return &config, err
 33}
 34
 35// Load loads the configuration from the default paths.
 36func Load(workingDir string, debug bool) (*Config, error) {
 37	// uses default config paths
 38	configPaths := []string{
 39		globalConfig(),
 40		globalConfigData(),
 41		filepath.Join(workingDir, fmt.Sprintf("%s.json", appName)),
 42		filepath.Join(workingDir, fmt.Sprintf(".%s.json", appName)),
 43	}
 44	cfg, err := loadFromConfigPaths(configPaths)
 45	if err != nil {
 46		return nil, fmt.Errorf("failed to load config from paths %v: %w", configPaths, err)
 47	}
 48
 49	cfg.setDefaults(workingDir)
 50
 51	if debug {
 52		cfg.Options.Debug = true
 53	}
 54
 55	// Init logs
 56	log.Init(
 57		filepath.Join(cfg.Options.DataDirectory, "logs", fmt.Sprintf("%s.log", appName)),
 58		cfg.Options.Debug,
 59	)
 60
 61	if err != nil {
 62		return nil, fmt.Errorf("failed to load config: %w", err)
 63	}
 64
 65	// Load known providers, this loads the config from fur
 66	providers, err := LoadProviders(client.New())
 67	if err != nil || len(providers) == 0 {
 68		return nil, fmt.Errorf("failed to load providers: %w", err)
 69	}
 70
 71	env := env.New()
 72	// Configure providers
 73	valueResolver := NewShellVariableResolver(env)
 74	cfg.resolver = valueResolver
 75	if err := cfg.configureProviders(env, valueResolver, providers); err != nil {
 76		return nil, fmt.Errorf("failed to configure providers: %w", err)
 77	}
 78
 79	if !cfg.IsConfigured() {
 80		slog.Warn("No providers configured")
 81		return cfg, nil
 82	}
 83
 84	if err := cfg.configureSelectedModels(providers); err != nil {
 85		return nil, fmt.Errorf("failed to configure selected models: %w", err)
 86	}
 87
 88	// TODO: remove the agents concept from the config
 89	agents := map[string]Agent{
 90		"coder": {
 91			ID:           "coder",
 92			Name:         "Coder",
 93			Description:  "An agent that helps with executing coding tasks.",
 94			Model:        SelectedModelTypeLarge,
 95			ContextPaths: cfg.Options.ContextPaths,
 96			// All tools allowed
 97		},
 98		"task": {
 99			ID:           "task",
100			Name:         "Task",
101			Description:  "An agent that helps with searching for context and finding implementation details.",
102			Model:        SelectedModelTypeLarge,
103			ContextPaths: cfg.Options.ContextPaths,
104			AllowedTools: []string{
105				"glob",
106				"grep",
107				"ls",
108				"sourcegraph",
109				"view",
110			},
111			// NO MCPs or LSPs by default
112			AllowedMCP: map[string][]string{},
113			AllowedLSP: []string{},
114		},
115	}
116	cfg.Agents = agents
117
118	return cfg, nil
119}
120
121func (cfg *Config) configureProviders(env env.Env, resolver VariableResolver, knownProviders []provider.Provider) error {
122	knownProviderNames := make(map[string]bool)
123	for _, p := range knownProviders {
124		knownProviderNames[string(p.ID)] = true
125		config, configExists := cfg.Providers[string(p.ID)]
126		// if the user configured a known provider we need to allow it to override a couple of parameters
127		if configExists {
128			if config.Disable {
129				slog.Debug("Skipping provider due to disable flag", "provider", p.ID)
130				delete(cfg.Providers, string(p.ID))
131				continue
132			}
133			if config.BaseURL != "" {
134				p.APIEndpoint = config.BaseURL
135			}
136			if config.APIKey != "" {
137				p.APIKey = config.APIKey
138			}
139			if len(config.Models) > 0 {
140				models := []provider.Model{}
141				seen := make(map[string]bool)
142
143				for _, model := range config.Models {
144					if seen[model.ID] {
145						continue
146					}
147					seen[model.ID] = true
148					if model.Model == "" {
149						model.Model = model.ID
150					}
151					models = append(models, model)
152				}
153				for _, model := range p.Models {
154					if seen[model.ID] {
155						continue
156					}
157					seen[model.ID] = true
158					if model.Model == "" {
159						model.Model = model.ID
160					}
161					models = append(models, model)
162				}
163
164				p.Models = models
165			}
166		}
167		prepared := ProviderConfig{
168			ID:           string(p.ID),
169			BaseURL:      p.APIEndpoint,
170			APIKey:       p.APIKey,
171			Type:         p.Type,
172			Disable:      config.Disable,
173			ExtraHeaders: config.ExtraHeaders,
174			ExtraParams:  make(map[string]string),
175			Models:       p.Models,
176		}
177
178		switch p.ID {
179		// Handle specific providers that require additional configuration
180		case provider.InferenceProviderVertexAI:
181			if !hasVertexCredentials(env) {
182				if configExists {
183					slog.Warn("Skipping Vertex AI provider due to missing credentials")
184					delete(cfg.Providers, string(p.ID))
185				}
186				continue
187			}
188			prepared.ExtraParams["project"] = env.Get("GOOGLE_CLOUD_PROJECT")
189			prepared.ExtraParams["location"] = env.Get("GOOGLE_CLOUD_LOCATION")
190		case provider.InferenceProviderBedrock:
191			if !hasAWSCredentials(env) {
192				if configExists {
193					slog.Warn("Skipping Bedrock provider due to missing AWS credentials")
194					delete(cfg.Providers, string(p.ID))
195				}
196				continue
197			}
198			for _, model := range p.Models {
199				if !strings.HasPrefix(model.ID, "anthropic.") {
200					return fmt.Errorf("bedrock provider only supports anthropic models for now, found: %s", model.ID)
201				}
202			}
203		default:
204			// if the provider api or endpoint are missing we skip them
205			v, err := resolver.ResolveValue(p.APIKey)
206			if v == "" || err != nil {
207				if configExists {
208					slog.Warn("Skipping provider due to missing API key", "provider", p.ID)
209					delete(cfg.Providers, string(p.ID))
210				}
211				continue
212			}
213		}
214		cfg.Providers[string(p.ID)] = prepared
215	}
216
217	// validate the custom providers
218	for id, providerConfig := range cfg.Providers {
219		if knownProviderNames[id] {
220			continue
221		}
222
223		// Make sure the provider ID is set
224		providerConfig.ID = id
225		// default to OpenAI if not set
226		if providerConfig.Type == "" {
227			providerConfig.Type = provider.TypeOpenAI
228		}
229
230		if providerConfig.Disable {
231			slog.Debug("Skipping custom provider due to disable flag", "provider", id)
232			delete(cfg.Providers, id)
233			continue
234		}
235		if providerConfig.APIKey == "" {
236			slog.Warn("Skipping custom provider due to missing API key", "provider", id)
237			delete(cfg.Providers, id)
238			continue
239		}
240		if providerConfig.BaseURL == "" {
241			slog.Warn("Skipping custom provider due to missing API endpoint", "provider", id)
242			delete(cfg.Providers, id)
243			continue
244		}
245		if len(providerConfig.Models) == 0 {
246			slog.Warn("Skipping custom provider because the provider has no models", "provider", id)
247			delete(cfg.Providers, id)
248			continue
249		}
250		if providerConfig.Type != provider.TypeOpenAI {
251			slog.Warn("Skipping custom provider because the provider type is not supported", "provider", id, "type", providerConfig.Type)
252			delete(cfg.Providers, id)
253			continue
254		}
255
256		apiKey, err := resolver.ResolveValue(providerConfig.APIKey)
257		if apiKey == "" || err != nil {
258			slog.Warn("Skipping custom provider due to missing API key", "provider", id, "error", err)
259			delete(cfg.Providers, id)
260			continue
261		}
262		baseURL, err := resolver.ResolveValue(providerConfig.BaseURL)
263		if baseURL == "" || err != nil {
264			slog.Warn("Skipping custom provider due to missing API endpoint", "provider", id, "error", err)
265			delete(cfg.Providers, id)
266			continue
267		}
268
269		cfg.Providers[id] = providerConfig
270	}
271	return nil
272}
273
274func (cfg *Config) setDefaults(workingDir string) {
275	cfg.workingDir = workingDir
276	if cfg.Options == nil {
277		cfg.Options = &Options{}
278	}
279	if cfg.Options.TUI == nil {
280		cfg.Options.TUI = &TUIOptions{}
281	}
282	if cfg.Options.ContextPaths == nil {
283		cfg.Options.ContextPaths = []string{}
284	}
285	if cfg.Options.DataDirectory == "" {
286		cfg.Options.DataDirectory = filepath.Join(workingDir, defaultDataDirectory)
287	}
288	if cfg.Providers == nil {
289		cfg.Providers = make(map[string]ProviderConfig)
290	}
291	if cfg.Models == nil {
292		cfg.Models = make(map[SelectedModelType]SelectedModel)
293	}
294	if cfg.MCP == nil {
295		cfg.MCP = make(map[string]MCPConfig)
296	}
297	if cfg.LSP == nil {
298		cfg.LSP = make(map[string]LSPConfig)
299	}
300
301	// Add the default context paths if they are not already present
302	cfg.Options.ContextPaths = append(defaultContextPaths, cfg.Options.ContextPaths...)
303	slices.Sort(cfg.Options.ContextPaths)
304	cfg.Options.ContextPaths = slices.Compact(cfg.Options.ContextPaths)
305}
306
307func (cfg *Config) defaultModelSelection(knownProviders []provider.Provider) (largeModel SelectedModel, smallModel SelectedModel, err error) {
308	if len(knownProviders) == 0 && len(cfg.Providers) == 0 {
309		err = fmt.Errorf("no providers configured, please configure at least one provider")
310		return
311	}
312
313	// Use the first provider enabled based on the known providers order
314	// if no provider found that is known use the first provider configured
315	for _, p := range knownProviders {
316		providerConfig, ok := cfg.Providers[string(p.ID)]
317		if !ok || providerConfig.Disable {
318			continue
319		}
320		defaultLargeModel := cfg.GetModel(string(p.ID), p.DefaultLargeModelID)
321		if defaultLargeModel == nil {
322			err = fmt.Errorf("default large model %s not found for provider %s", p.DefaultLargeModelID, p.ID)
323			return
324		}
325		largeModel = SelectedModel{
326			Provider:        string(p.ID),
327			Model:           defaultLargeModel.ID,
328			MaxTokens:       defaultLargeModel.DefaultMaxTokens,
329			ReasoningEffort: defaultLargeModel.DefaultReasoningEffort,
330		}
331
332		defaultSmallModel := cfg.GetModel(string(p.ID), p.DefaultSmallModelID)
333		if defaultSmallModel == nil {
334			err = fmt.Errorf("default small model %s not found for provider %s", p.DefaultSmallModelID, p.ID)
335		}
336		smallModel = SelectedModel{
337			Provider:        string(p.ID),
338			Model:           defaultSmallModel.ID,
339			MaxTokens:       defaultSmallModel.DefaultMaxTokens,
340			ReasoningEffort: defaultSmallModel.DefaultReasoningEffort,
341		}
342		return
343	}
344
345	enabledProviders := cfg.EnabledProviders()
346	slices.SortFunc(enabledProviders, func(a, b ProviderConfig) int {
347		return strings.Compare(a.ID, b.ID)
348	})
349
350	if len(enabledProviders) == 0 {
351		err = fmt.Errorf("no providers configured, please configure at least one provider")
352		return
353	}
354
355	providerConfig := enabledProviders[0]
356	if len(providerConfig.Models) == 0 {
357		err = fmt.Errorf("provider %s has no models configured", providerConfig.ID)
358		return
359	}
360	defaultLargeModel := cfg.GetModel(providerConfig.ID, providerConfig.Models[0].ID)
361	largeModel = SelectedModel{
362		Provider:  providerConfig.ID,
363		Model:     defaultLargeModel.ID,
364		MaxTokens: defaultLargeModel.DefaultMaxTokens,
365	}
366	defaultSmallModel := cfg.GetModel(providerConfig.ID, providerConfig.Models[0].ID)
367	smallModel = SelectedModel{
368		Provider:  providerConfig.ID,
369		Model:     defaultSmallModel.ID,
370		MaxTokens: defaultSmallModel.DefaultMaxTokens,
371	}
372	return
373}
374
375func (cfg *Config) configureSelectedModels(knownProviders []provider.Provider) error {
376	large, small, err := cfg.defaultModelSelection(knownProviders)
377	if err != nil {
378		return fmt.Errorf("failed to select default models: %w", err)
379	}
380
381	largeModelSelected, largeModelConfigured := cfg.Models[SelectedModelTypeLarge]
382	if largeModelConfigured {
383		if largeModelSelected.Model != "" {
384			large.Model = largeModelSelected.Model
385		}
386		if largeModelSelected.Provider != "" {
387			large.Provider = largeModelSelected.Provider
388		}
389		model := cfg.GetModel(large.Provider, large.Model)
390		if model == nil {
391			return fmt.Errorf("large model %s not found for provider %s", large.Model, large.Provider)
392		}
393		if largeModelSelected.MaxTokens > 0 {
394			large.MaxTokens = largeModelSelected.MaxTokens
395		} else {
396			large.MaxTokens = model.DefaultMaxTokens
397		}
398		if largeModelSelected.ReasoningEffort != "" {
399			large.ReasoningEffort = largeModelSelected.ReasoningEffort
400		}
401		large.Think = largeModelSelected.Think
402	}
403	smallModelSelected, smallModelConfigured := cfg.Models[SelectedModelTypeSmall]
404	if smallModelConfigured {
405		if smallModelSelected.Model != "" {
406			small.Model = smallModelSelected.Model
407		}
408		if smallModelSelected.Provider != "" {
409			small.Provider = smallModelSelected.Provider
410		}
411
412		model := cfg.GetModel(small.Provider, small.Model)
413		if model == nil {
414			return fmt.Errorf("large model %s not found for provider %s", large.Model, large.Provider)
415		}
416		if smallModelSelected.MaxTokens > 0 {
417			small.MaxTokens = smallModelSelected.MaxTokens
418		} else {
419			small.MaxTokens = model.DefaultMaxTokens
420		}
421		small.ReasoningEffort = smallModelSelected.ReasoningEffort
422		small.Think = smallModelSelected.Think
423	}
424
425	// validate the selected models
426	largeModel := cfg.GetModel(large.Provider, large.Model)
427	if largeModel == nil {
428		return fmt.Errorf("large model %s not found for provider %s", large.Model, large.Provider)
429	}
430	smallModel := cfg.GetModel(small.Provider, small.Model)
431	if smallModel == nil {
432		return fmt.Errorf("small model %s not found for provider %s", small.Model, small.Provider)
433	}
434	cfg.Models[SelectedModelTypeLarge] = large
435	cfg.Models[SelectedModelTypeSmall] = small
436	return nil
437}
438
439func loadFromConfigPaths(configPaths []string) (*Config, error) {
440	var configs []io.Reader
441
442	for _, path := range configPaths {
443		fd, err := os.Open(path)
444		if err != nil {
445			if os.IsNotExist(err) {
446				continue
447			}
448			return nil, fmt.Errorf("failed to open config file %s: %w", path, err)
449		}
450		defer fd.Close()
451
452		configs = append(configs, fd)
453	}
454
455	return loadFromReaders(configs)
456}
457
458func loadFromReaders(readers []io.Reader) (*Config, error) {
459	if len(readers) == 0 {
460		return &Config{}, nil
461	}
462
463	merged, err := Merge(readers)
464	if err != nil {
465		return nil, fmt.Errorf("failed to merge configuration readers: %w", err)
466	}
467
468	return LoadReader(merged)
469}
470
471func hasVertexCredentials(env env.Env) bool {
472	useVertex := env.Get("GOOGLE_GENAI_USE_VERTEXAI") == "true"
473	hasProject := env.Get("GOOGLE_CLOUD_PROJECT") != ""
474	hasLocation := env.Get("GOOGLE_CLOUD_LOCATION") != ""
475	return useVertex && hasProject && hasLocation
476}
477
478func hasAWSCredentials(env env.Env) bool {
479	if env.Get("AWS_ACCESS_KEY_ID") != "" && env.Get("AWS_SECRET_ACCESS_KEY") != "" {
480		return true
481	}
482
483	if env.Get("AWS_PROFILE") != "" || env.Get("AWS_DEFAULT_PROFILE") != "" {
484		return true
485	}
486
487	if env.Get("AWS_REGION") != "" || env.Get("AWS_DEFAULT_REGION") != "" {
488		return true
489	}
490
491	if env.Get("AWS_CONTAINER_CREDENTIALS_RELATIVE_URI") != "" ||
492		env.Get("AWS_CONTAINER_CREDENTIALS_FULL_URI") != "" {
493		return true
494	}
495
496	return false
497}
498
499func globalConfig() string {
500	xdgConfigHome := os.Getenv("XDG_CONFIG_HOME")
501	if xdgConfigHome != "" {
502		return filepath.Join(xdgConfigHome, appName, fmt.Sprintf("%s.json", appName))
503	}
504
505	// return the path to the main config directory
506	// for windows, it should be in `%LOCALAPPDATA%/crush/`
507	// for linux and macOS, it should be in `$HOME/.config/crush/`
508	if runtime.GOOS == "windows" {
509		localAppData := os.Getenv("LOCALAPPDATA")
510		if localAppData == "" {
511			localAppData = filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local")
512		}
513		return filepath.Join(localAppData, appName, fmt.Sprintf("%s.json", appName))
514	}
515
516	return filepath.Join(os.Getenv("HOME"), ".config", appName, fmt.Sprintf("%s.json", appName))
517}
518
519// globalConfigData returns the path to the main data directory for the application.
520// this config is used when the app overrides configurations instead of updating the global config.
521func globalConfigData() string {
522	xdgDataHome := os.Getenv("XDG_DATA_HOME")
523	if xdgDataHome != "" {
524		return filepath.Join(xdgDataHome, appName, fmt.Sprintf("%s.json", appName))
525	}
526
527	// return the path to the main data directory
528	// for windows, it should be in `%LOCALAPPDATA%/crush/`
529	// for linux and macOS, it should be in `$HOME/.local/share/crush/`
530	if runtime.GOOS == "windows" {
531		localAppData := os.Getenv("LOCALAPPDATA")
532		if localAppData == "" {
533			localAppData = filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local")
534		}
535		return filepath.Join(localAppData, appName, fmt.Sprintf("%s.json", appName))
536	}
537
538	return filepath.Join(os.Getenv("HOME"), ".local", "share", appName, fmt.Sprintf("%s.json", appName))
539}