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 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)
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 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 c.Options.DataDirectory == "" {
314 if path, ok := fsext.SearchParent(workingDir, defaultDataDirectory); ok {
315 c.Options.DataDirectory = path
316 } else {
317 c.Options.DataDirectory = filepath.Join(workingDir, defaultDataDirectory)
318 }
319 }
320 if c.Providers == nil {
321 c.Providers = csync.NewMap[string, ProviderConfig]()
322 }
323 if c.Models == nil {
324 c.Models = make(map[SelectedModelType]SelectedModel)
325 }
326 if c.MCP == nil {
327 c.MCP = make(map[string]MCPConfig)
328 }
329 if c.LSP == nil {
330 c.LSP = make(map[string]LSPConfig)
331 }
332
333 // Apply default file types for known LSP servers if not specified
334 applyDefaultLSPFileTypes(c.LSP)
335
336 // Add the default context paths if they are not already present
337 c.Options.ContextPaths = append(defaultContextPaths, c.Options.ContextPaths...)
338 slices.Sort(c.Options.ContextPaths)
339 c.Options.ContextPaths = slices.Compact(c.Options.ContextPaths)
340}
341
342var defaultLSPFileTypes = map[string][]string{
343 "gopls": {"go", "mod", "sum", "work"},
344 "typescript-language-server": {"ts", "tsx", "js", "jsx", "mjs", "cjs"},
345 "vtsls": {"ts", "tsx", "js", "jsx", "mjs", "cjs"},
346 "bash-language-server": {"sh", "bash", "zsh", "ksh"},
347 "rust-analyzer": {"rs"},
348 "pyright": {"py", "pyi"},
349 "pylsp": {"py", "pyi"},
350 "clangd": {"c", "cpp", "cc", "cxx", "h", "hpp"},
351 "jdtls": {"java"},
352 "vscode-html-languageserver": {"html", "htm"},
353 "vscode-css-languageserver": {"css", "scss", "sass", "less"},
354 "vscode-json-languageserver": {"json", "jsonc"},
355 "yaml-language-server": {"yaml", "yml"},
356 "lua-language-server": {"lua"},
357 "solargraph": {"rb"},
358 "elixir-ls": {"ex", "exs"},
359 "zls": {"zig"},
360}
361
362// applyDefaultLSPFileTypes sets default file types for known LSP servers
363func applyDefaultLSPFileTypes(lspConfigs map[string]LSPConfig) {
364 for name, config := range lspConfigs {
365 if len(config.FileTypes) != 0 {
366 continue
367 }
368 bin := strings.ToLower(filepath.Base(config.Command))
369 config.FileTypes = defaultLSPFileTypes[bin]
370 lspConfigs[name] = config
371 }
372}
373
374func (c *Config) defaultModelSelection(knownProviders []catwalk.Provider) (largeModel SelectedModel, smallModel SelectedModel, err error) {
375 if len(knownProviders) == 0 && c.Providers.Len() == 0 {
376 err = fmt.Errorf("no providers configured, please configure at least one provider")
377 return
378 }
379
380 // Use the first provider enabled based on the known providers order
381 // if no provider found that is known use the first provider configured
382 for _, p := range knownProviders {
383 providerConfig, ok := c.Providers.Get(string(p.ID))
384 if !ok || providerConfig.Disable {
385 continue
386 }
387 defaultLargeModel := c.GetModel(string(p.ID), p.DefaultLargeModelID)
388 if defaultLargeModel == nil {
389 err = fmt.Errorf("default large model %s not found for provider %s", p.DefaultLargeModelID, p.ID)
390 return
391 }
392 largeModel = SelectedModel{
393 Provider: string(p.ID),
394 Model: defaultLargeModel.ID,
395 MaxTokens: defaultLargeModel.DefaultMaxTokens,
396 ReasoningEffort: defaultLargeModel.DefaultReasoningEffort,
397 }
398
399 defaultSmallModel := c.GetModel(string(p.ID), p.DefaultSmallModelID)
400 if defaultSmallModel == nil {
401 err = fmt.Errorf("default small model %s not found for provider %s", p.DefaultSmallModelID, p.ID)
402 return
403 }
404 smallModel = SelectedModel{
405 Provider: string(p.ID),
406 Model: defaultSmallModel.ID,
407 MaxTokens: defaultSmallModel.DefaultMaxTokens,
408 ReasoningEffort: defaultSmallModel.DefaultReasoningEffort,
409 }
410 return
411 }
412
413 enabledProviders := c.EnabledProviders()
414 slices.SortFunc(enabledProviders, func(a, b ProviderConfig) int {
415 return strings.Compare(a.ID, b.ID)
416 })
417
418 if len(enabledProviders) == 0 {
419 err = fmt.Errorf("no providers configured, please configure at least one provider")
420 return
421 }
422
423 providerConfig := enabledProviders[0]
424 if len(providerConfig.Models) == 0 {
425 err = fmt.Errorf("provider %s has no models configured", providerConfig.ID)
426 return
427 }
428 defaultLargeModel := c.GetModel(providerConfig.ID, providerConfig.Models[0].ID)
429 largeModel = SelectedModel{
430 Provider: providerConfig.ID,
431 Model: defaultLargeModel.ID,
432 MaxTokens: defaultLargeModel.DefaultMaxTokens,
433 }
434 defaultSmallModel := c.GetModel(providerConfig.ID, providerConfig.Models[0].ID)
435 smallModel = SelectedModel{
436 Provider: providerConfig.ID,
437 Model: defaultSmallModel.ID,
438 MaxTokens: defaultSmallModel.DefaultMaxTokens,
439 }
440 return
441}
442
443func (c *Config) configureSelectedModels(knownProviders []catwalk.Provider) error {
444 defaultLarge, defaultSmall, err := c.defaultModelSelection(knownProviders)
445 if err != nil {
446 return fmt.Errorf("failed to select default models: %w", err)
447 }
448 large, small := defaultLarge, defaultSmall
449
450 largeModelSelected, largeModelConfigured := c.Models[SelectedModelTypeLarge]
451 if largeModelConfigured {
452 if largeModelSelected.Model != "" {
453 large.Model = largeModelSelected.Model
454 }
455 if largeModelSelected.Provider != "" {
456 large.Provider = largeModelSelected.Provider
457 }
458 model := c.GetModel(large.Provider, large.Model)
459 if model == nil {
460 large = defaultLarge
461 // override the model type to large
462 err := c.UpdatePreferredModel(SelectedModelTypeLarge, large)
463 if err != nil {
464 return fmt.Errorf("failed to update preferred large model: %w", err)
465 }
466 } else {
467 if largeModelSelected.MaxTokens > 0 {
468 large.MaxTokens = largeModelSelected.MaxTokens
469 } else {
470 large.MaxTokens = model.DefaultMaxTokens
471 }
472 if largeModelSelected.ReasoningEffort != "" {
473 large.ReasoningEffort = largeModelSelected.ReasoningEffort
474 }
475 large.Think = largeModelSelected.Think
476 }
477 }
478 smallModelSelected, smallModelConfigured := c.Models[SelectedModelTypeSmall]
479 if smallModelConfigured {
480 if smallModelSelected.Model != "" {
481 small.Model = smallModelSelected.Model
482 }
483 if smallModelSelected.Provider != "" {
484 small.Provider = smallModelSelected.Provider
485 }
486
487 model := c.GetModel(small.Provider, small.Model)
488 if model == nil {
489 small = defaultSmall
490 // override the model type to small
491 err := c.UpdatePreferredModel(SelectedModelTypeSmall, small)
492 if err != nil {
493 return fmt.Errorf("failed to update preferred small model: %w", err)
494 }
495 } else {
496 if smallModelSelected.MaxTokens > 0 {
497 small.MaxTokens = smallModelSelected.MaxTokens
498 } else {
499 small.MaxTokens = model.DefaultMaxTokens
500 }
501 small.ReasoningEffort = smallModelSelected.ReasoningEffort
502 small.Think = smallModelSelected.Think
503 }
504 }
505 c.Models[SelectedModelTypeLarge] = large
506 c.Models[SelectedModelTypeSmall] = small
507 return nil
508}
509
510func loadFromConfigPaths(configPaths []string) (*Config, error) {
511 var configs []io.Reader
512
513 for _, path := range configPaths {
514 fd, err := os.Open(path)
515 if err != nil {
516 if os.IsNotExist(err) {
517 continue
518 }
519 return nil, fmt.Errorf("failed to open config file %s: %w", path, err)
520 }
521 defer fd.Close()
522
523 configs = append(configs, fd)
524 }
525
526 return loadFromReaders(configs)
527}
528
529func loadFromReaders(readers []io.Reader) (*Config, error) {
530 if len(readers) == 0 {
531 return &Config{}, nil
532 }
533
534 merged, err := Merge(readers)
535 if err != nil {
536 return nil, fmt.Errorf("failed to merge configuration readers: %w", err)
537 }
538
539 return LoadReader(merged)
540}
541
542func hasVertexCredentials(env env.Env) bool {
543 hasProject := env.Get("VERTEXAI_PROJECT") != ""
544 hasLocation := env.Get("VERTEXAI_LOCATION") != ""
545 return hasProject && hasLocation
546}
547
548func hasAWSCredentials(env env.Env) bool {
549 if env.Get("AWS_ACCESS_KEY_ID") != "" && env.Get("AWS_SECRET_ACCESS_KEY") != "" {
550 return true
551 }
552
553 if env.Get("AWS_PROFILE") != "" || env.Get("AWS_DEFAULT_PROFILE") != "" {
554 return true
555 }
556
557 if env.Get("AWS_REGION") != "" || env.Get("AWS_DEFAULT_REGION") != "" {
558 return true
559 }
560
561 if env.Get("AWS_CONTAINER_CREDENTIALS_RELATIVE_URI") != "" ||
562 env.Get("AWS_CONTAINER_CREDENTIALS_FULL_URI") != "" {
563 return true
564 }
565 return false
566}
567
568func globalConfig() string {
569 xdgConfigHome := os.Getenv("XDG_CONFIG_HOME")
570 if xdgConfigHome != "" {
571 return filepath.Join(xdgConfigHome, appName, fmt.Sprintf("%s.json", appName))
572 }
573
574 // return the path to the main config directory
575 // for windows, it should be in `%LOCALAPPDATA%/crush/`
576 // for linux and macOS, it should be in `$HOME/.config/crush/`
577 if runtime.GOOS == "windows" {
578 localAppData := os.Getenv("LOCALAPPDATA")
579 if localAppData == "" {
580 localAppData = filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local")
581 }
582 return filepath.Join(localAppData, appName, fmt.Sprintf("%s.json", appName))
583 }
584
585 return filepath.Join(os.Getenv("HOME"), ".config", appName, fmt.Sprintf("%s.json", appName))
586}
587
588// GlobalConfigData returns the path to the main data directory for the application.
589// this config is used when the app overrides configurations instead of updating the global config.
590func GlobalConfigData() string {
591 xdgDataHome := os.Getenv("XDG_DATA_HOME")
592 if xdgDataHome != "" {
593 return filepath.Join(xdgDataHome, appName, fmt.Sprintf("%s.json", appName))
594 }
595
596 // return the path to the main data directory
597 // for windows, it should be in `%LOCALAPPDATA%/crush/`
598 // for linux and macOS, it should be in `$HOME/.local/share/crush/`
599 if runtime.GOOS == "windows" {
600 localAppData := os.Getenv("LOCALAPPDATA")
601 if localAppData == "" {
602 localAppData = filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local")
603 }
604 return filepath.Join(localAppData, appName, fmt.Sprintf("%s.json", appName))
605 }
606
607 return filepath.Join(os.Getenv("HOME"), ".local", "share", appName, fmt.Sprintf("%s.json", appName))
608}