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(c.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) knownProviderTypes() []catwalk.Type {
307 return []catwalk.Type{
308 catwalk.TypeOpenAI,
309 catwalk.TypeAnthropic,
310 catwalk.TypeAzure,
311 catwalk.TypeBedrock,
312 catwalk.TypeGoogle,
313 catwalk.TypeVertexAI,
314 catwalk.TypeOpenAICompat,
315 }
316}
317
318func (c *Config) setDefaults(workingDir, dataDir string) {
319 c.workingDir = workingDir
320 if c.Options == nil {
321 c.Options = &Options{}
322 }
323 if c.Options.TUI == nil {
324 c.Options.TUI = &TUIOptions{}
325 }
326 if c.Options.ContextPaths == nil {
327 c.Options.ContextPaths = []string{}
328 }
329 if dataDir != "" {
330 c.Options.DataDirectory = dataDir
331 } else if c.Options.DataDirectory == "" {
332 if path, ok := fsext.LookupClosest(workingDir, defaultDataDirectory); ok {
333 c.Options.DataDirectory = path
334 } else {
335 c.Options.DataDirectory = filepath.Join(workingDir, defaultDataDirectory)
336 }
337 }
338 if c.Providers == nil {
339 c.Providers = csync.NewMap[string, ProviderConfig]()
340 }
341 if c.Models == nil {
342 c.Models = make(map[SelectedModelType]SelectedModel)
343 }
344 if c.MCP == nil {
345 c.MCP = make(map[string]MCPConfig)
346 }
347 if c.LSP == nil {
348 c.LSP = make(map[string]LSPConfig)
349 }
350
351 // Apply defaults to LSP configurations
352 c.applyLSPDefaults()
353
354 // Add the default context paths if they are not already present
355 c.Options.ContextPaths = append(defaultContextPaths, c.Options.ContextPaths...)
356 slices.Sort(c.Options.ContextPaths)
357 c.Options.ContextPaths = slices.Compact(c.Options.ContextPaths)
358
359 if str, ok := os.LookupEnv("CRUSH_DISABLE_PROVIDER_AUTO_UPDATE"); ok {
360 c.Options.DisableProviderAutoUpdate, _ = strconv.ParseBool(str)
361 }
362
363 if c.Options.Attribution == nil {
364 c.Options.Attribution = &Attribution{
365 CoAuthoredBy: true,
366 GeneratedWith: true,
367 }
368 }
369}
370
371// applyLSPDefaults applies default values from powernap to LSP configurations
372func (c *Config) applyLSPDefaults() {
373 // Get powernap's default configuration
374 configManager := powernapConfig.NewManager()
375 configManager.LoadDefaults()
376
377 // Apply defaults to each LSP configuration
378 for name, cfg := range c.LSP {
379 // Try to get defaults from powernap based on name or command name.
380 base, ok := configManager.GetServer(name)
381 if !ok {
382 base, ok = configManager.GetServer(cfg.Command)
383 if !ok {
384 continue
385 }
386 }
387 if cfg.Options == nil {
388 cfg.Options = base.Settings
389 }
390 if cfg.InitOptions == nil {
391 cfg.InitOptions = base.InitOptions
392 }
393 if len(cfg.FileTypes) == 0 {
394 cfg.FileTypes = base.FileTypes
395 }
396 if len(cfg.RootMarkers) == 0 {
397 cfg.RootMarkers = base.RootMarkers
398 }
399 if cfg.Command == "" {
400 cfg.Command = base.Command
401 }
402 if len(cfg.Args) == 0 {
403 cfg.Args = base.Args
404 }
405 if len(cfg.Env) == 0 {
406 cfg.Env = base.Environment
407 }
408 // Update the config in the map
409 c.LSP[name] = cfg
410 }
411}
412
413func (c *Config) defaultModelSelection(knownProviders []catwalk.Provider) (largeModel SelectedModel, smallModel SelectedModel, err error) {
414 if len(knownProviders) == 0 && c.Providers.Len() == 0 {
415 err = fmt.Errorf("no providers configured, please configure at least one provider")
416 return largeModel, smallModel, err
417 }
418
419 // Use the first provider enabled based on the known providers order
420 // if no provider found that is known use the first provider configured
421 for _, p := range knownProviders {
422 providerConfig, ok := c.Providers.Get(string(p.ID))
423 if !ok || providerConfig.Disable {
424 continue
425 }
426 defaultLargeModel := c.GetModel(string(p.ID), p.DefaultLargeModelID)
427 if defaultLargeModel == nil {
428 err = fmt.Errorf("default large model %s not found for provider %s", p.DefaultLargeModelID, p.ID)
429 return largeModel, smallModel, err
430 }
431 largeModel = SelectedModel{
432 Provider: string(p.ID),
433 Model: defaultLargeModel.ID,
434 MaxTokens: defaultLargeModel.DefaultMaxTokens,
435 ReasoningEffort: defaultLargeModel.DefaultReasoningEffort,
436 }
437
438 defaultSmallModel := c.GetModel(string(p.ID), p.DefaultSmallModelID)
439 if defaultSmallModel == nil {
440 err = fmt.Errorf("default small model %s not found for provider %s", p.DefaultSmallModelID, p.ID)
441 return largeModel, smallModel, err
442 }
443 smallModel = SelectedModel{
444 Provider: string(p.ID),
445 Model: defaultSmallModel.ID,
446 MaxTokens: defaultSmallModel.DefaultMaxTokens,
447 ReasoningEffort: defaultSmallModel.DefaultReasoningEffort,
448 }
449 return largeModel, smallModel, err
450 }
451
452 enabledProviders := c.EnabledProviders()
453 slices.SortFunc(enabledProviders, func(a, b ProviderConfig) int {
454 return strings.Compare(a.ID, b.ID)
455 })
456
457 if len(enabledProviders) == 0 {
458 err = fmt.Errorf("no providers configured, please configure at least one provider")
459 return largeModel, smallModel, err
460 }
461
462 providerConfig := enabledProviders[0]
463 if len(providerConfig.Models) == 0 {
464 err = fmt.Errorf("provider %s has no models configured", providerConfig.ID)
465 return largeModel, smallModel, err
466 }
467 defaultLargeModel := c.GetModel(providerConfig.ID, providerConfig.Models[0].ID)
468 largeModel = SelectedModel{
469 Provider: providerConfig.ID,
470 Model: defaultLargeModel.ID,
471 MaxTokens: defaultLargeModel.DefaultMaxTokens,
472 }
473 defaultSmallModel := c.GetModel(providerConfig.ID, providerConfig.Models[0].ID)
474 smallModel = SelectedModel{
475 Provider: providerConfig.ID,
476 Model: defaultSmallModel.ID,
477 MaxTokens: defaultSmallModel.DefaultMaxTokens,
478 }
479 return largeModel, smallModel, err
480}
481
482func (c *Config) configureSelectedModels(knownProviders []catwalk.Provider) error {
483 defaultLarge, defaultSmall, err := c.defaultModelSelection(knownProviders)
484 if err != nil {
485 return fmt.Errorf("failed to select default models: %w", err)
486 }
487 large, small := defaultLarge, defaultSmall
488
489 largeModelSelected, largeModelConfigured := c.Models[SelectedModelTypeLarge]
490 if largeModelConfigured {
491 if largeModelSelected.Model != "" {
492 large.Model = largeModelSelected.Model
493 }
494 if largeModelSelected.Provider != "" {
495 large.Provider = largeModelSelected.Provider
496 }
497 model := c.GetModel(large.Provider, large.Model)
498 if model == nil {
499 large = defaultLarge
500 // override the model type to large
501 err := c.UpdatePreferredModel(SelectedModelTypeLarge, large)
502 if err != nil {
503 return fmt.Errorf("failed to update preferred large model: %w", err)
504 }
505 } else {
506 if largeModelSelected.MaxTokens > 0 {
507 large.MaxTokens = largeModelSelected.MaxTokens
508 } else {
509 large.MaxTokens = model.DefaultMaxTokens
510 }
511 if largeModelSelected.ReasoningEffort != "" {
512 large.ReasoningEffort = largeModelSelected.ReasoningEffort
513 }
514 large.Think = largeModelSelected.Think
515 }
516 }
517 smallModelSelected, smallModelConfigured := c.Models[SelectedModelTypeSmall]
518 if smallModelConfigured {
519 if smallModelSelected.Model != "" {
520 small.Model = smallModelSelected.Model
521 }
522 if smallModelSelected.Provider != "" {
523 small.Provider = smallModelSelected.Provider
524 }
525
526 model := c.GetModel(small.Provider, small.Model)
527 if model == nil {
528 small = defaultSmall
529 // override the model type to small
530 err := c.UpdatePreferredModel(SelectedModelTypeSmall, small)
531 if err != nil {
532 return fmt.Errorf("failed to update preferred small model: %w", err)
533 }
534 } else {
535 if smallModelSelected.MaxTokens > 0 {
536 small.MaxTokens = smallModelSelected.MaxTokens
537 } else {
538 small.MaxTokens = model.DefaultMaxTokens
539 }
540 small.ReasoningEffort = smallModelSelected.ReasoningEffort
541 small.Think = smallModelSelected.Think
542 }
543 }
544 c.Models[SelectedModelTypeLarge] = large
545 c.Models[SelectedModelTypeSmall] = small
546 return nil
547}
548
549// lookupConfigs searches config files recursively from CWD up to FS root
550func lookupConfigs(cwd string) []string {
551 // prepend default config paths
552 configPaths := []string{
553 GlobalConfig(),
554 GlobalConfigData(),
555 }
556
557 configNames := []string{appName + ".json", "." + appName + ".json"}
558
559 foundConfigs, err := fsext.Lookup(cwd, configNames...)
560 if err != nil {
561 // returns at least default configs
562 return configPaths
563 }
564
565 // reverse order so last config has more priority
566 slices.Reverse(foundConfigs)
567
568 return append(configPaths, foundConfigs...)
569}
570
571func loadFromConfigPaths(configPaths []string) (*Config, error) {
572 var configs []io.Reader
573
574 for _, path := range configPaths {
575 fd, err := os.Open(path)
576 if err != nil {
577 if os.IsNotExist(err) {
578 continue
579 }
580 return nil, fmt.Errorf("failed to open config file %s: %w", path, err)
581 }
582 defer fd.Close()
583
584 configs = append(configs, fd)
585 }
586
587 return loadFromReaders(configs)
588}
589
590func loadFromReaders(readers []io.Reader) (*Config, error) {
591 if len(readers) == 0 {
592 return &Config{}, nil
593 }
594
595 merged, err := Merge(readers)
596 if err != nil {
597 return nil, fmt.Errorf("failed to merge configuration readers: %w", err)
598 }
599
600 return LoadReader(merged)
601}
602
603func hasVertexCredentials(env env.Env) bool {
604 hasProject := env.Get("VERTEXAI_PROJECT") != ""
605 hasLocation := env.Get("VERTEXAI_LOCATION") != ""
606 return hasProject && hasLocation
607}
608
609func hasAWSCredentials(env env.Env) bool {
610 if env.Get("AWS_ACCESS_KEY_ID") != "" && env.Get("AWS_SECRET_ACCESS_KEY") != "" {
611 return true
612 }
613
614 if env.Get("AWS_PROFILE") != "" || env.Get("AWS_DEFAULT_PROFILE") != "" {
615 return true
616 }
617
618 if env.Get("AWS_REGION") != "" || env.Get("AWS_DEFAULT_REGION") != "" {
619 return true
620 }
621
622 if env.Get("AWS_CONTAINER_CREDENTIALS_RELATIVE_URI") != "" ||
623 env.Get("AWS_CONTAINER_CREDENTIALS_FULL_URI") != "" {
624 return true
625 }
626 return false
627}
628
629// GlobalConfig returns the global configuration file path for the application.
630func GlobalConfig() string {
631 xdgConfigHome := os.Getenv("XDG_CONFIG_HOME")
632 if xdgConfigHome != "" {
633 return filepath.Join(xdgConfigHome, appName, fmt.Sprintf("%s.json", appName))
634 }
635
636 // return the path to the main config directory
637 // for windows, it should be in `%LOCALAPPDATA%/crush/`
638 // for linux and macOS, it should be in `$HOME/.config/crush/`
639 if runtime.GOOS == "windows" {
640 localAppData := os.Getenv("LOCALAPPDATA")
641 if localAppData == "" {
642 localAppData = filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local")
643 }
644 return filepath.Join(localAppData, appName, fmt.Sprintf("%s.json", appName))
645 }
646
647 return filepath.Join(home.Dir(), ".config", appName, fmt.Sprintf("%s.json", appName))
648}
649
650// GlobalConfigData returns the path to the main data directory for the application.
651// this config is used when the app overrides configurations instead of updating the global config.
652func GlobalConfigData() string {
653 xdgDataHome := os.Getenv("XDG_DATA_HOME")
654 if xdgDataHome != "" {
655 return filepath.Join(xdgDataHome, appName, fmt.Sprintf("%s.json", appName))
656 }
657
658 // return the path to the main data directory
659 // for windows, it should be in `%LOCALAPPDATA%/crush/`
660 // for linux and macOS, it should be in `$HOME/.local/share/crush/`
661 if runtime.GOOS == "windows" {
662 localAppData := os.Getenv("LOCALAPPDATA")
663 if localAppData == "" {
664 localAppData = filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local")
665 }
666 return filepath.Join(localAppData, appName, fmt.Sprintf("%s.json", appName))
667 }
668
669 return filepath.Join(home.Dir(), ".local", "share", appName, fmt.Sprintf("%s.json", appName))
670}
671
672func assignIfNil[T any](ptr **T, val T) {
673 if *ptr == nil {
674 *ptr = &val
675 }
676}
677
678func isInsideWorktree() bool {
679 bts, err := exec.CommandContext(
680 context.Background(),
681 "git", "rev-parse",
682 "--is-inside-work-tree",
683 ).CombinedOutput()
684 return err == nil && strings.TrimSpace(string(bts)) == "true"
685}