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