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