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 "strings"
14
15 "github.com/charmbracelet/catwalk/pkg/catwalk"
16 "github.com/charmbracelet/crush/internal/csync"
17 "github.com/charmbracelet/crush/internal/env"
18 "github.com/charmbracelet/crush/internal/fsext"
19 "github.com/charmbracelet/crush/internal/log"
20)
21
22const defaultCatwalkURL = "https://catwalk.charm.sh"
23
24// LoadReader config via io.Reader.
25func LoadReader(fd io.Reader) (*Config, error) {
26 data, err := io.ReadAll(fd)
27 if err != nil {
28 return nil, err
29 }
30
31 var config Config
32 err = json.Unmarshal(data, &config)
33 if err != nil {
34 return nil, err
35 }
36 return &config, err
37}
38
39// Load loads the configuration from the default paths.
40func Load(workingDir, dataDir string, debug bool) (*Config, error) {
41 // uses default config paths
42 configPaths := []string{
43 globalConfig(),
44 GlobalConfigData(),
45 filepath.Join(workingDir, fmt.Sprintf("%s.json", appName)),
46 filepath.Join(workingDir, fmt.Sprintf(".%s.json", appName)),
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 // Load known providers, this loads the config from catwalk
68 providers, err := Providers()
69 if err != nil || len(providers) == 0 {
70 return nil, fmt.Errorf("failed to load providers: %w", err)
71 }
72 cfg.knownProviders = providers
73
74 env := env.New()
75 // Configure providers
76 valueResolver := NewShellVariableResolver(env)
77 cfg.resolver = valueResolver
78 if err := cfg.configureProviders(env, valueResolver, providers); err != nil {
79 return nil, fmt.Errorf("failed to configure providers: %w", err)
80 }
81
82 if !cfg.IsConfigured() {
83 slog.Warn("No providers configured")
84 return cfg, nil
85 }
86
87 if err := cfg.configureSelectedModels(providers); err != nil {
88 return nil, fmt.Errorf("failed to configure selected models: %w", err)
89 }
90 cfg.SetupAgents()
91 return cfg, nil
92}
93
94func PushPopCrushEnv() func() {
95 found := []string{}
96 for _, ev := range os.Environ() {
97 if strings.HasPrefix(ev, "CRUSH_") {
98 pair := strings.SplitN(ev, "=", 2)
99 if len(pair) != 2 {
100 continue
101 }
102 found = append(found, strings.TrimPrefix(pair[0], "CRUSH_"))
103 }
104 }
105 backups := make(map[string]string)
106 for _, ev := range found {
107 backups[ev] = os.Getenv(ev)
108 }
109
110 for _, ev := range found {
111 os.Setenv(ev, os.Getenv("CRUSH_"+ev))
112 }
113
114 restore := func() {
115 for k, v := range backups {
116 os.Setenv(k, v)
117 }
118 }
119 return restore
120}
121
122func (c *Config) configureProviders(env env.Env, resolver VariableResolver, knownProviders []catwalk.Provider) error {
123 knownProviderNames := make(map[string]bool)
124 restore := PushPopCrushEnv()
125 defer restore()
126 for _, p := range knownProviders {
127 knownProviderNames[string(p.ID)] = true
128 config, configExists := c.Providers.Get(string(p.ID))
129 // if the user configured a known provider we need to allow it to override a couple of parameters
130 if configExists {
131 if config.Disable {
132 slog.Debug("Skipping provider due to disable flag", "provider", p.ID)
133 c.Providers.Del(string(p.ID))
134 continue
135 }
136 if config.BaseURL != "" {
137 p.APIEndpoint = config.BaseURL
138 }
139 if config.APIKey != "" {
140 p.APIKey = config.APIKey
141 }
142 if len(config.Models) > 0 {
143 models := []catwalk.Model{}
144 seen := make(map[string]bool)
145
146 for _, model := range config.Models {
147 if seen[model.ID] {
148 continue
149 }
150 seen[model.ID] = true
151 if model.Name == "" {
152 model.Name = model.ID
153 }
154 models = append(models, model)
155 }
156 for _, model := range p.Models {
157 if seen[model.ID] {
158 continue
159 }
160 seen[model.ID] = true
161 if model.Name == "" {
162 model.Name = model.ID
163 }
164 models = append(models, model)
165 }
166
167 p.Models = models
168 }
169 }
170
171 headers := map[string]string{}
172 if len(p.DefaultHeaders) > 0 {
173 maps.Copy(headers, p.DefaultHeaders)
174 }
175 if len(config.ExtraHeaders) > 0 {
176 maps.Copy(headers, config.ExtraHeaders)
177 }
178 prepared := ProviderConfig{
179 ID: string(p.ID),
180 Name: p.Name,
181 BaseURL: p.APIEndpoint,
182 APIKey: p.APIKey,
183 Type: p.Type,
184 Disable: config.Disable,
185 SystemPromptPrefix: config.SystemPromptPrefix,
186 ExtraHeaders: headers,
187 ExtraBody: config.ExtraBody,
188 ExtraParams: make(map[string]string),
189 Models: p.Models,
190 }
191
192 switch p.ID {
193 // Handle specific providers that require additional configuration
194 case catwalk.InferenceProviderVertexAI:
195 if !hasVertexCredentials(env) {
196 if configExists {
197 slog.Warn("Skipping Vertex AI provider due to missing credentials")
198 c.Providers.Del(string(p.ID))
199 }
200 continue
201 }
202 prepared.ExtraParams["project"] = env.Get("VERTEXAI_PROJECT")
203 prepared.ExtraParams["location"] = env.Get("VERTEXAI_LOCATION")
204 case catwalk.InferenceProviderAzure:
205 endpoint, err := resolver.ResolveValue(p.APIEndpoint)
206 if err != nil || endpoint == "" {
207 if configExists {
208 slog.Warn("Skipping Azure provider due to missing API endpoint", "provider", p.ID, "error", err)
209 c.Providers.Del(string(p.ID))
210 }
211 continue
212 }
213 prepared.BaseURL = endpoint
214 prepared.ExtraParams["apiVersion"] = env.Get("AZURE_OPENAI_API_VERSION")
215 case catwalk.InferenceProviderBedrock:
216 if !hasAWSCredentials(env) {
217 if configExists {
218 slog.Warn("Skipping Bedrock provider due to missing AWS credentials")
219 c.Providers.Del(string(p.ID))
220 }
221 continue
222 }
223 prepared.ExtraParams["region"] = env.Get("AWS_REGION")
224 if prepared.ExtraParams["region"] == "" {
225 prepared.ExtraParams["region"] = env.Get("AWS_DEFAULT_REGION")
226 }
227 for _, model := range p.Models {
228 if !strings.HasPrefix(model.ID, "anthropic.") {
229 return fmt.Errorf("bedrock provider only supports anthropic models for now, found: %s", model.ID)
230 }
231 }
232 default:
233 // if the provider api or endpoint are missing we skip them
234 v, err := resolver.ResolveValue(p.APIKey)
235 if v == "" || err != nil {
236 if configExists {
237 slog.Warn("Skipping provider due to missing API key", "provider", p.ID)
238 c.Providers.Del(string(p.ID))
239 }
240 continue
241 }
242 }
243 c.Providers.Set(string(p.ID), prepared)
244 }
245
246 // validate the custom providers
247 for id, providerConfig := range c.Providers.Seq2() {
248 if knownProviderNames[id] {
249 continue
250 }
251
252 // Make sure the provider ID is set
253 providerConfig.ID = id
254 if providerConfig.Name == "" {
255 providerConfig.Name = id // Use ID as name if not set
256 }
257 // default to OpenAI if not set
258 if providerConfig.Type == "" {
259 providerConfig.Type = catwalk.TypeOpenAI
260 }
261
262 if providerConfig.Disable {
263 slog.Debug("Skipping custom provider due to disable flag", "provider", id)
264 c.Providers.Del(id)
265 continue
266 }
267 if providerConfig.APIKey == "" {
268 slog.Warn("Provider is missing API key, this might be OK for local providers", "provider", id)
269 }
270 if providerConfig.BaseURL == "" {
271 slog.Warn("Skipping custom provider due to missing API endpoint", "provider", id)
272 c.Providers.Del(id)
273 continue
274 }
275 if len(providerConfig.Models) == 0 {
276 slog.Warn("Skipping custom provider because the provider has no models", "provider", id)
277 c.Providers.Del(id)
278 continue
279 }
280 if providerConfig.Type != catwalk.TypeOpenAI && providerConfig.Type != catwalk.TypeAnthropic {
281 slog.Warn("Skipping custom provider because the provider type is not supported", "provider", id, "type", providerConfig.Type)
282 c.Providers.Del(id)
283 continue
284 }
285
286 apiKey, err := resolver.ResolveValue(providerConfig.APIKey)
287 if apiKey == "" || err != nil {
288 slog.Warn("Provider is missing API key, this might be OK for local providers", "provider", id)
289 }
290 baseURL, err := resolver.ResolveValue(providerConfig.BaseURL)
291 if baseURL == "" || err != nil {
292 slog.Warn("Skipping custom provider due to missing API endpoint", "provider", id, "error", err)
293 c.Providers.Del(id)
294 continue
295 }
296
297 c.Providers.Set(id, providerConfig)
298 }
299 return nil
300}
301
302func (c *Config) setDefaults(workingDir, dataDir string) {
303 c.workingDir = workingDir
304 if c.Options == nil {
305 c.Options = &Options{}
306 }
307 if c.Options.TUI == nil {
308 c.Options.TUI = &TUIOptions{}
309 }
310 if c.Options.ContextPaths == nil {
311 c.Options.ContextPaths = []string{}
312 }
313 if dataDir != "" {
314 c.Options.DataDirectory = dataDir
315 } else if c.Options.DataDirectory == "" {
316 if path, ok := fsext.SearchParent(workingDir, defaultDataDirectory); ok {
317 c.Options.DataDirectory = path
318 } else {
319 c.Options.DataDirectory = filepath.Join(workingDir, defaultDataDirectory)
320 }
321 }
322 if c.Providers == nil {
323 c.Providers = csync.NewMap[string, ProviderConfig]()
324 }
325 if c.Models == nil {
326 c.Models = make(map[SelectedModelType]SelectedModel)
327 }
328 if c.MCP == nil {
329 c.MCP = make(map[string]MCPConfig)
330 }
331 if c.LSP == nil {
332 c.LSP = make(map[string]LSPConfig)
333 }
334
335 // Apply default file types for known LSP servers if not specified
336 applyDefaultLSPFileTypes(c.LSP)
337
338 // Add the default context paths if they are not already present
339 c.Options.ContextPaths = append(defaultContextPaths, c.Options.ContextPaths...)
340 slices.Sort(c.Options.ContextPaths)
341 c.Options.ContextPaths = slices.Compact(c.Options.ContextPaths)
342}
343
344var defaultLSPFileTypes = map[string][]string{
345 "gopls": {"go", "mod", "sum", "work"},
346 "typescript-language-server": {"ts", "tsx", "js", "jsx", "mjs", "cjs"},
347 "vtsls": {"ts", "tsx", "js", "jsx", "mjs", "cjs"},
348 "bash-language-server": {"sh", "bash", "zsh", "ksh"},
349 "rust-analyzer": {"rs"},
350 "pyright": {"py", "pyi"},
351 "pylsp": {"py", "pyi"},
352 "clangd": {"c", "cpp", "cc", "cxx", "h", "hpp"},
353 "jdtls": {"java"},
354 "vscode-html-languageserver": {"html", "htm"},
355 "vscode-css-languageserver": {"css", "scss", "sass", "less"},
356 "vscode-json-languageserver": {"json", "jsonc"},
357 "yaml-language-server": {"yaml", "yml"},
358 "lua-language-server": {"lua"},
359 "solargraph": {"rb"},
360 "elixir-ls": {"ex", "exs"},
361 "zls": {"zig"},
362}
363
364// applyDefaultLSPFileTypes sets default file types for known LSP servers
365func applyDefaultLSPFileTypes(lspConfigs map[string]LSPConfig) {
366 for name, config := range lspConfigs {
367 if len(config.FileTypes) != 0 {
368 continue
369 }
370 bin := strings.ToLower(filepath.Base(config.Command))
371 config.FileTypes = defaultLSPFileTypes[bin]
372 lspConfigs[name] = config
373 }
374}
375
376func (c *Config) defaultModelSelection(knownProviders []catwalk.Provider) (largeModel SelectedModel, smallModel SelectedModel, err error) {
377 if len(knownProviders) == 0 && c.Providers.Len() == 0 {
378 err = fmt.Errorf("no providers configured, please configure at least one provider")
379 return
380 }
381
382 // Use the first provider enabled based on the known providers order
383 // if no provider found that is known use the first provider configured
384 for _, p := range knownProviders {
385 providerConfig, ok := c.Providers.Get(string(p.ID))
386 if !ok || providerConfig.Disable {
387 continue
388 }
389 defaultLargeModel := c.GetModel(string(p.ID), p.DefaultLargeModelID)
390 if defaultLargeModel == nil {
391 err = fmt.Errorf("default large model %s not found for provider %s", p.DefaultLargeModelID, p.ID)
392 return
393 }
394 largeModel = SelectedModel{
395 Provider: string(p.ID),
396 Model: defaultLargeModel.ID,
397 MaxTokens: defaultLargeModel.DefaultMaxTokens,
398 ReasoningEffort: defaultLargeModel.DefaultReasoningEffort,
399 }
400
401 defaultSmallModel := c.GetModel(string(p.ID), p.DefaultSmallModelID)
402 if defaultSmallModel == nil {
403 err = fmt.Errorf("default small model %s not found for provider %s", p.DefaultSmallModelID, p.ID)
404 return
405 }
406 smallModel = SelectedModel{
407 Provider: string(p.ID),
408 Model: defaultSmallModel.ID,
409 MaxTokens: defaultSmallModel.DefaultMaxTokens,
410 ReasoningEffort: defaultSmallModel.DefaultReasoningEffort,
411 }
412 return
413 }
414
415 enabledProviders := c.EnabledProviders()
416 slices.SortFunc(enabledProviders, func(a, b ProviderConfig) int {
417 return strings.Compare(a.ID, b.ID)
418 })
419
420 if len(enabledProviders) == 0 {
421 err = fmt.Errorf("no providers configured, please configure at least one provider")
422 return
423 }
424
425 providerConfig := enabledProviders[0]
426 if len(providerConfig.Models) == 0 {
427 err = fmt.Errorf("provider %s has no models configured", providerConfig.ID)
428 return
429 }
430 defaultLargeModel := c.GetModel(providerConfig.ID, providerConfig.Models[0].ID)
431 largeModel = SelectedModel{
432 Provider: providerConfig.ID,
433 Model: defaultLargeModel.ID,
434 MaxTokens: defaultLargeModel.DefaultMaxTokens,
435 }
436 defaultSmallModel := c.GetModel(providerConfig.ID, providerConfig.Models[0].ID)
437 smallModel = SelectedModel{
438 Provider: providerConfig.ID,
439 Model: defaultSmallModel.ID,
440 MaxTokens: defaultSmallModel.DefaultMaxTokens,
441 }
442 return
443}
444
445func (c *Config) configureSelectedModels(knownProviders []catwalk.Provider) error {
446 defaultLarge, defaultSmall, err := c.defaultModelSelection(knownProviders)
447 if err != nil {
448 return fmt.Errorf("failed to select default models: %w", err)
449 }
450 large, small := defaultLarge, defaultSmall
451
452 largeModelSelected, largeModelConfigured := c.Models[SelectedModelTypeLarge]
453 if largeModelConfigured {
454 if largeModelSelected.Model != "" {
455 large.Model = largeModelSelected.Model
456 }
457 if largeModelSelected.Provider != "" {
458 large.Provider = largeModelSelected.Provider
459 }
460 model := c.GetModel(large.Provider, large.Model)
461 if model == nil {
462 large = defaultLarge
463 // override the model type to large
464 err := c.UpdatePreferredModel(SelectedModelTypeLarge, large)
465 if err != nil {
466 return fmt.Errorf("failed to update preferred large model: %w", err)
467 }
468 } else {
469 if largeModelSelected.MaxTokens > 0 {
470 large.MaxTokens = largeModelSelected.MaxTokens
471 } else {
472 large.MaxTokens = model.DefaultMaxTokens
473 }
474 if largeModelSelected.ReasoningEffort != "" {
475 large.ReasoningEffort = largeModelSelected.ReasoningEffort
476 }
477 large.Think = largeModelSelected.Think
478 }
479 }
480 smallModelSelected, smallModelConfigured := c.Models[SelectedModelTypeSmall]
481 if smallModelConfigured {
482 if smallModelSelected.Model != "" {
483 small.Model = smallModelSelected.Model
484 }
485 if smallModelSelected.Provider != "" {
486 small.Provider = smallModelSelected.Provider
487 }
488
489 model := c.GetModel(small.Provider, small.Model)
490 if model == nil {
491 small = defaultSmall
492 // override the model type to small
493 err := c.UpdatePreferredModel(SelectedModelTypeSmall, small)
494 if err != nil {
495 return fmt.Errorf("failed to update preferred small model: %w", err)
496 }
497 } else {
498 if smallModelSelected.MaxTokens > 0 {
499 small.MaxTokens = smallModelSelected.MaxTokens
500 } else {
501 small.MaxTokens = model.DefaultMaxTokens
502 }
503 small.ReasoningEffort = smallModelSelected.ReasoningEffort
504 small.Think = smallModelSelected.Think
505 }
506 }
507 c.Models[SelectedModelTypeLarge] = large
508 c.Models[SelectedModelTypeSmall] = small
509 return nil
510}
511
512func loadFromConfigPaths(configPaths []string) (*Config, error) {
513 var configs []io.Reader
514
515 for _, path := range configPaths {
516 fd, err := os.Open(path)
517 if err != nil {
518 if os.IsNotExist(err) {
519 continue
520 }
521 return nil, fmt.Errorf("failed to open config file %s: %w", path, err)
522 }
523 defer fd.Close()
524
525 configs = append(configs, fd)
526 }
527
528 return loadFromReaders(configs)
529}
530
531func loadFromReaders(readers []io.Reader) (*Config, error) {
532 if len(readers) == 0 {
533 return &Config{}, nil
534 }
535
536 merged, err := Merge(readers)
537 if err != nil {
538 return nil, fmt.Errorf("failed to merge configuration readers: %w", err)
539 }
540
541 return LoadReader(merged)
542}
543
544func hasVertexCredentials(env env.Env) bool {
545 hasProject := env.Get("VERTEXAI_PROJECT") != ""
546 hasLocation := env.Get("VERTEXAI_LOCATION") != ""
547 return hasProject && hasLocation
548}
549
550func hasAWSCredentials(env env.Env) bool {
551 if env.Get("AWS_ACCESS_KEY_ID") != "" && env.Get("AWS_SECRET_ACCESS_KEY") != "" {
552 return true
553 }
554
555 if env.Get("AWS_PROFILE") != "" || env.Get("AWS_DEFAULT_PROFILE") != "" {
556 return true
557 }
558
559 if env.Get("AWS_REGION") != "" || env.Get("AWS_DEFAULT_REGION") != "" {
560 return true
561 }
562
563 if env.Get("AWS_CONTAINER_CREDENTIALS_RELATIVE_URI") != "" ||
564 env.Get("AWS_CONTAINER_CREDENTIALS_FULL_URI") != "" {
565 return true
566 }
567 return false
568}
569
570func globalConfig() string {
571 xdgConfigHome := os.Getenv("XDG_CONFIG_HOME")
572 if xdgConfigHome != "" {
573 return filepath.Join(xdgConfigHome, appName, fmt.Sprintf("%s.json", appName))
574 }
575
576 // return the path to the main config directory
577 // for windows, it should be in `%LOCALAPPDATA%/crush/`
578 // for linux and macOS, it should be in `$HOME/.config/crush/`
579 if runtime.GOOS == "windows" {
580 localAppData := os.Getenv("LOCALAPPDATA")
581 if localAppData == "" {
582 localAppData = filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local")
583 }
584 return filepath.Join(localAppData, appName, fmt.Sprintf("%s.json", appName))
585 }
586
587 return filepath.Join(os.Getenv("HOME"), ".config", appName, fmt.Sprintf("%s.json", appName))
588}
589
590// GlobalConfigData returns the path to the main data directory for the application.
591// this config is used when the app overrides configurations instead of updating the global config.
592func GlobalConfigData() string {
593 xdgDataHome := os.Getenv("XDG_DATA_HOME")
594 if xdgDataHome != "" {
595 return filepath.Join(xdgDataHome, appName, fmt.Sprintf("%s.json", appName))
596 }
597
598 // return the path to the main data directory
599 // for windows, it should be in `%LOCALAPPDATA%/crush/`
600 // for linux and macOS, it should be in `$HOME/.local/share/crush/`
601 if runtime.GOOS == "windows" {
602 localAppData := os.Getenv("LOCALAPPDATA")
603 if localAppData == "" {
604 localAppData = filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local")
605 }
606 return filepath.Join(localAppData, appName, fmt.Sprintf("%s.json", appName))
607 }
608
609 return filepath.Join(os.Getenv("HOME"), ".local", "share", appName, fmt.Sprintf("%s.json", appName))
610}