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