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