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