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