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