1package config
2
3import (
4 "encoding/json"
5 "fmt"
6 "io"
7 "log/slog"
8 "os"
9 "path/filepath"
10 "runtime"
11 "slices"
12 "strings"
13 "sync"
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/log"
19)
20
21const catwalkURL = "https://catwalk.charm.sh"
22
23// LoadReader config via io.Reader.
24func LoadReader(fd io.Reader) (*Config, error) {
25 data, err := io.ReadAll(fd)
26 if err != nil {
27 return nil, err
28 }
29
30 var config Config
31 err = json.Unmarshal(data, &config)
32 if err != nil {
33 return nil, err
34 }
35 return &config, err
36}
37
38// Load loads the configuration from the default paths.
39func Load(workingDir string, debug bool) (*Config, error) {
40 // uses default config paths
41 configPaths := []string{
42 globalConfig(),
43 GlobalConfigData(),
44 filepath.Join(workingDir, fmt.Sprintf("%s.json", appName)),
45 filepath.Join(workingDir, fmt.Sprintf(".%s.json", appName)),
46 }
47 cfg, err := loadFromConfigPaths(configPaths)
48 if err != nil {
49 return nil, fmt.Errorf("failed to load config from paths %v: %w", configPaths, err)
50 }
51
52 cfg.dataConfigDir = GlobalConfigData()
53
54 cfg.setDefaults(workingDir)
55
56 if debug {
57 cfg.Options.Debug = true
58 }
59
60 // Setup logs
61 log.Setup(
62 filepath.Join(cfg.Options.DataDirectory, "logs", fmt.Sprintf("%s.log", appName)),
63 cfg.Options.Debug,
64 )
65
66 // Load known providers, this loads the config from catwalk
67 providers, err := Providers()
68 if err != nil || len(providers) == 0 {
69 return nil, fmt.Errorf("failed to load providers: %w", err)
70 }
71 cfg.knownProviders = providers
72
73 env := env.New()
74 // Configure providers
75 valueResolver := NewShellVariableResolver(env)
76 cfg.resolver = valueResolver
77 if err := cfg.configureProviders(env, valueResolver, providers); err != nil {
78 return nil, fmt.Errorf("failed to configure providers: %w", err)
79 }
80
81 go cfg.removeUnresponsiveProviders()
82
83 if !cfg.IsConfigured() {
84 slog.Warn("No providers configured")
85 return cfg, nil
86 }
87
88 if err := cfg.configureSelectedModels(providers); err != nil {
89 return nil, fmt.Errorf("failed to configure selected models: %w", err)
90 }
91 cfg.SetupAgents()
92 return cfg, nil
93}
94
95func (c *Config) removeUnresponsiveProviders() {
96 // Test provider connections in parallel
97 var testResults sync.Map
98 var wg sync.WaitGroup
99 slog.Info("Testing provider connections")
100 defer slog.Info("Provider connection tests completed")
101 for _, p := range c.Providers.Seq2() {
102 if p.Type == catwalk.TypeOpenAI || p.Type == catwalk.TypeAnthropic {
103 wg.Add(1)
104 go func(provider ProviderConfig) {
105 defer wg.Done()
106 err := provider.TestConnection(c.resolver)
107 testResults.Store(provider.ID, err == nil)
108 if err != nil {
109 slog.Error("Provider connection test failed", "provider", provider.ID, "error", err)
110 }
111 }(p)
112 }
113 }
114 wg.Wait()
115
116 // Remove failed providers
117 testResults.Range(func(key, value any) bool {
118 providerID := key.(string)
119 passed := value.(bool)
120 if !passed {
121 c.Providers.Del(providerID)
122 }
123 return true
124 })
125}
126
127func (c *Config) configureProviders(env env.Env, resolver VariableResolver, knownProviders []catwalk.Provider) error {
128 knownProviderNames := make(map[string]bool)
129 for _, p := range knownProviders {
130 knownProviderNames[string(p.ID)] = true
131 config, configExists := c.Providers.Get(string(p.ID))
132 // if the user configured a known provider we need to allow it to override a couple of parameters
133 if configExists {
134 if config.Disable {
135 slog.Debug("Skipping provider due to disable flag", "provider", p.ID)
136 c.Providers.Del(string(p.ID))
137 continue
138 }
139 if config.BaseURL != "" {
140 p.APIEndpoint = config.BaseURL
141 }
142 if config.APIKey != "" {
143 p.APIKey = config.APIKey
144 }
145 if len(config.Models) > 0 {
146 models := []catwalk.Model{}
147 seen := make(map[string]bool)
148
149 for _, model := range config.Models {
150 if seen[model.ID] {
151 continue
152 }
153 seen[model.ID] = true
154 if model.Name == "" {
155 model.Name = model.ID
156 }
157 models = append(models, model)
158 }
159 for _, model := range p.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
170 p.Models = models
171 }
172 }
173 prepared := ProviderConfig{
174 ID: string(p.ID),
175 Name: p.Name,
176 BaseURL: p.APIEndpoint,
177 APIKey: p.APIKey,
178 Type: p.Type,
179 Disable: config.Disable,
180 ExtraHeaders: config.ExtraHeaders,
181 ExtraBody: config.ExtraBody,
182 ExtraParams: make(map[string]string),
183 Models: p.Models,
184 }
185
186 switch p.ID {
187 // Handle specific providers that require additional configuration
188 case catwalk.InferenceProviderVertexAI:
189 if !hasVertexCredentials(env) {
190 if configExists {
191 slog.Warn("Skipping Vertex AI provider due to missing credentials")
192 c.Providers.Del(string(p.ID))
193 }
194 continue
195 }
196 prepared.ExtraParams["project"] = env.Get("GOOGLE_CLOUD_PROJECT")
197 prepared.ExtraParams["location"] = env.Get("GOOGLE_CLOUD_LOCATION")
198 case catwalk.InferenceProviderAzure:
199 endpoint, err := resolver.ResolveValue(p.APIEndpoint)
200 if err != nil || endpoint == "" {
201 if configExists {
202 slog.Warn("Skipping Azure provider due to missing API endpoint", "provider", p.ID, "error", err)
203 c.Providers.Del(string(p.ID))
204 }
205 continue
206 }
207 prepared.BaseURL = endpoint
208 prepared.ExtraParams["apiVersion"] = env.Get("AZURE_OPENAI_API_VERSION")
209 case catwalk.InferenceProviderBedrock:
210 if !hasAWSCredentials(env) {
211 if configExists {
212 slog.Warn("Skipping Bedrock provider due to missing AWS credentials")
213 c.Providers.Del(string(p.ID))
214 }
215 continue
216 }
217 for _, model := range p.Models {
218 if !strings.HasPrefix(model.ID, "anthropic.") {
219 return fmt.Errorf("bedrock provider only supports anthropic models for now, found: %s", model.ID)
220 }
221 }
222 default:
223 // if the provider api or endpoint are missing we skip them
224 v, err := resolver.ResolveValue(p.APIKey)
225 if v == "" || err != nil {
226 if configExists {
227 slog.Warn("Skipping provider due to missing API key", "provider", p.ID)
228 c.Providers.Del(string(p.ID))
229 }
230 continue
231 }
232 }
233 c.Providers.Set(string(p.ID), prepared)
234 }
235
236 // validate the custom providers
237 for id, providerConfig := range c.Providers.Seq2() {
238 if knownProviderNames[id] {
239 continue
240 }
241
242 // Make sure the provider ID is set
243 providerConfig.ID = id
244 if providerConfig.Name == "" {
245 providerConfig.Name = id // Use ID as name if not set
246 }
247 // default to OpenAI if not set
248 if providerConfig.Type == "" {
249 providerConfig.Type = catwalk.TypeOpenAI
250 }
251
252 if providerConfig.Disable {
253 slog.Debug("Skipping custom provider due to disable flag", "provider", id)
254 c.Providers.Del(id)
255 continue
256 }
257 if providerConfig.APIKey == "" {
258 slog.Warn("Provider is missing API key, this might be OK for local providers", "provider", id)
259 }
260 if providerConfig.BaseURL == "" {
261 slog.Warn("Skipping custom provider due to missing API endpoint", "provider", id)
262 c.Providers.Del(id)
263 continue
264 }
265 if len(providerConfig.Models) == 0 {
266 slog.Warn("Skipping custom provider because the provider has no models", "provider", id)
267 c.Providers.Del(id)
268 continue
269 }
270 if providerConfig.Type != catwalk.TypeOpenAI {
271 slog.Warn("Skipping custom provider because the provider type is not supported", "provider", id, "type", providerConfig.Type)
272 c.Providers.Del(id)
273 continue
274 }
275
276 apiKey, err := resolver.ResolveValue(providerConfig.APIKey)
277 if apiKey == "" || err != nil {
278 slog.Warn("Provider is missing API key, this might be OK for local providers", "provider", id)
279 }
280 baseURL, err := resolver.ResolveValue(providerConfig.BaseURL)
281 if baseURL == "" || err != nil {
282 slog.Warn("Skipping custom provider due to missing API endpoint", "provider", id, "error", err)
283 c.Providers.Del(id)
284 continue
285 }
286
287 c.Providers.Set(id, providerConfig)
288 }
289 return nil
290}
291
292func (c *Config) setDefaults(workingDir string) {
293 c.workingDir = workingDir
294 if c.Options == nil {
295 c.Options = &Options{}
296 }
297 if c.Options.TUI == nil {
298 c.Options.TUI = &TUIOptions{}
299 }
300 if c.Options.ContextPaths == nil {
301 c.Options.ContextPaths = []string{}
302 }
303 if c.Options.DataDirectory == "" {
304 c.Options.DataDirectory = filepath.Join(workingDir, defaultDataDirectory)
305 }
306 if c.Providers == nil {
307 c.Providers = csync.NewMap[string, ProviderConfig]()
308 }
309 if c.Models == nil {
310 c.Models = make(map[SelectedModelType]SelectedModel)
311 }
312 if c.MCP == nil {
313 c.MCP = make(map[string]MCPConfig)
314 }
315 if c.LSP == nil {
316 c.LSP = make(map[string]LSPConfig)
317 }
318
319 // Add the default context paths if they are not already present
320 c.Options.ContextPaths = append(defaultContextPaths, c.Options.ContextPaths...)
321 slices.Sort(c.Options.ContextPaths)
322 c.Options.ContextPaths = slices.Compact(c.Options.ContextPaths)
323}
324
325func (c *Config) defaultModelSelection(knownProviders []catwalk.Provider) (largeModel SelectedModel, smallModel SelectedModel, err error) {
326 if len(knownProviders) == 0 && c.Providers.Len() == 0 {
327 err = fmt.Errorf("no providers configured, please configure at least one provider")
328 return
329 }
330
331 // Use the first provider enabled based on the known providers order
332 // if no provider found that is known use the first provider configured
333 for _, p := range knownProviders {
334 providerConfig, ok := c.Providers.Get(string(p.ID))
335 if !ok || providerConfig.Disable {
336 continue
337 }
338 defaultLargeModel := c.GetModel(string(p.ID), p.DefaultLargeModelID)
339 if defaultLargeModel == nil {
340 err = fmt.Errorf("default large model %s not found for provider %s", p.DefaultLargeModelID, p.ID)
341 return
342 }
343 largeModel = SelectedModel{
344 Provider: string(p.ID),
345 Model: defaultLargeModel.ID,
346 MaxTokens: defaultLargeModel.DefaultMaxTokens,
347 ReasoningEffort: defaultLargeModel.DefaultReasoningEffort,
348 }
349
350 defaultSmallModel := c.GetModel(string(p.ID), p.DefaultSmallModelID)
351 if defaultSmallModel == nil {
352 err = fmt.Errorf("default small model %s not found for provider %s", p.DefaultSmallModelID, p.ID)
353 return
354 }
355 smallModel = SelectedModel{
356 Provider: string(p.ID),
357 Model: defaultSmallModel.ID,
358 MaxTokens: defaultSmallModel.DefaultMaxTokens,
359 ReasoningEffort: defaultSmallModel.DefaultReasoningEffort,
360 }
361 return
362 }
363
364 enabledProviders := c.EnabledProviders()
365 slices.SortFunc(enabledProviders, func(a, b ProviderConfig) int {
366 return strings.Compare(a.ID, b.ID)
367 })
368
369 if len(enabledProviders) == 0 {
370 err = fmt.Errorf("no providers configured, please configure at least one provider")
371 return
372 }
373
374 providerConfig := enabledProviders[0]
375 if len(providerConfig.Models) == 0 {
376 err = fmt.Errorf("provider %s has no models configured", providerConfig.ID)
377 return
378 }
379 defaultLargeModel := c.GetModel(providerConfig.ID, providerConfig.Models[0].ID)
380 largeModel = SelectedModel{
381 Provider: providerConfig.ID,
382 Model: defaultLargeModel.ID,
383 MaxTokens: defaultLargeModel.DefaultMaxTokens,
384 }
385 defaultSmallModel := c.GetModel(providerConfig.ID, providerConfig.Models[0].ID)
386 smallModel = SelectedModel{
387 Provider: providerConfig.ID,
388 Model: defaultSmallModel.ID,
389 MaxTokens: defaultSmallModel.DefaultMaxTokens,
390 }
391 return
392}
393
394func (c *Config) configureSelectedModels(knownProviders []catwalk.Provider) error {
395 defaultLarge, defaultSmall, err := c.defaultModelSelection(knownProviders)
396 if err != nil {
397 return fmt.Errorf("failed to select default models: %w", err)
398 }
399 large, small := defaultLarge, defaultSmall
400
401 largeModelSelected, largeModelConfigured := c.Models[SelectedModelTypeLarge]
402 if largeModelConfigured {
403 if largeModelSelected.Model != "" {
404 large.Model = largeModelSelected.Model
405 }
406 if largeModelSelected.Provider != "" {
407 large.Provider = largeModelSelected.Provider
408 }
409 model := c.GetModel(large.Provider, large.Model)
410 if model == nil {
411 large = defaultLarge
412 // override the model type to large
413 err := c.UpdatePreferredModel(SelectedModelTypeLarge, large)
414 if err != nil {
415 return fmt.Errorf("failed to update preferred large model: %w", err)
416 }
417 } else {
418 if largeModelSelected.MaxTokens > 0 {
419 large.MaxTokens = largeModelSelected.MaxTokens
420 } else {
421 large.MaxTokens = model.DefaultMaxTokens
422 }
423 if largeModelSelected.ReasoningEffort != "" {
424 large.ReasoningEffort = largeModelSelected.ReasoningEffort
425 }
426 large.Think = largeModelSelected.Think
427 }
428 }
429 smallModelSelected, smallModelConfigured := c.Models[SelectedModelTypeSmall]
430 if smallModelConfigured {
431 if smallModelSelected.Model != "" {
432 small.Model = smallModelSelected.Model
433 }
434 if smallModelSelected.Provider != "" {
435 small.Provider = smallModelSelected.Provider
436 }
437
438 model := c.GetModel(small.Provider, small.Model)
439 if model == nil {
440 small = defaultSmall
441 // override the model type to small
442 err := c.UpdatePreferredModel(SelectedModelTypeSmall, small)
443 if err != nil {
444 return fmt.Errorf("failed to update preferred small model: %w", err)
445 }
446 } else {
447 if smallModelSelected.MaxTokens > 0 {
448 small.MaxTokens = smallModelSelected.MaxTokens
449 } else {
450 small.MaxTokens = model.DefaultMaxTokens
451 }
452 small.ReasoningEffort = smallModelSelected.ReasoningEffort
453 small.Think = smallModelSelected.Think
454 }
455 }
456 c.Models[SelectedModelTypeLarge] = large
457 c.Models[SelectedModelTypeSmall] = small
458 return nil
459}
460
461func loadFromConfigPaths(configPaths []string) (*Config, error) {
462 var configs []io.Reader
463
464 for _, path := range configPaths {
465 fd, err := os.Open(path)
466 if err != nil {
467 if os.IsNotExist(err) {
468 continue
469 }
470 return nil, fmt.Errorf("failed to open config file %s: %w", path, err)
471 }
472 defer fd.Close()
473
474 configs = append(configs, fd)
475 }
476
477 return loadFromReaders(configs)
478}
479
480func loadFromReaders(readers []io.Reader) (*Config, error) {
481 if len(readers) == 0 {
482 return &Config{}, nil
483 }
484
485 merged, err := Merge(readers)
486 if err != nil {
487 return nil, fmt.Errorf("failed to merge configuration readers: %w", err)
488 }
489
490 return LoadReader(merged)
491}
492
493func hasVertexCredentials(env env.Env) bool {
494 useVertex := env.Get("GOOGLE_GENAI_USE_VERTEXAI") == "true"
495 hasProject := env.Get("GOOGLE_CLOUD_PROJECT") != ""
496 hasLocation := env.Get("GOOGLE_CLOUD_LOCATION") != ""
497 return useVertex && hasProject && hasLocation
498}
499
500func hasAWSCredentials(env env.Env) bool {
501 if env.Get("AWS_ACCESS_KEY_ID") != "" && env.Get("AWS_SECRET_ACCESS_KEY") != "" {
502 return true
503 }
504
505 if env.Get("AWS_PROFILE") != "" || env.Get("AWS_DEFAULT_PROFILE") != "" {
506 return true
507 }
508
509 if env.Get("AWS_REGION") != "" || env.Get("AWS_DEFAULT_REGION") != "" {
510 return true
511 }
512
513 if env.Get("AWS_CONTAINER_CREDENTIALS_RELATIVE_URI") != "" ||
514 env.Get("AWS_CONTAINER_CREDENTIALS_FULL_URI") != "" {
515 return true
516 }
517
518 return false
519}
520
521func globalConfig() string {
522 xdgConfigHome := os.Getenv("XDG_CONFIG_HOME")
523 if xdgConfigHome != "" {
524 return filepath.Join(xdgConfigHome, appName, fmt.Sprintf("%s.json", appName))
525 }
526
527 // return the path to the main config directory
528 // for windows, it should be in `%LOCALAPPDATA%/crush/`
529 // for linux and macOS, it should be in `$HOME/.config/crush/`
530 if runtime.GOOS == "windows" {
531 localAppData := os.Getenv("LOCALAPPDATA")
532 if localAppData == "" {
533 localAppData = filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local")
534 }
535 return filepath.Join(localAppData, appName, fmt.Sprintf("%s.json", appName))
536 }
537
538 return filepath.Join(os.Getenv("HOME"), ".config", appName, fmt.Sprintf("%s.json", appName))
539}
540
541// GlobalConfigData returns the path to the main data directory for the application.
542// this config is used when the app overrides configurations instead of updating the global config.
543func GlobalConfigData() string {
544 xdgDataHome := os.Getenv("XDG_DATA_HOME")
545 if xdgDataHome != "" {
546 return filepath.Join(xdgDataHome, appName, fmt.Sprintf("%s.json", appName))
547 }
548
549 // return the path to the main data directory
550 // for windows, it should be in `%LOCALAPPDATA%/crush/`
551 // for linux and macOS, it should be in `$HOME/.local/share/crush/`
552 if runtime.GOOS == "windows" {
553 localAppData := os.Getenv("LOCALAPPDATA")
554 if localAppData == "" {
555 localAppData = filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local")
556 }
557 return filepath.Join(localAppData, appName, fmt.Sprintf("%s.json", appName))
558 }
559
560 return filepath.Join(os.Getenv("HOME"), ".local", "share", appName, fmt.Sprintf("%s.json", appName))
561}
562
563func HomeDir() string {
564 homeDir := os.Getenv("HOME")
565 if homeDir == "" {
566 homeDir = os.Getenv("USERPROFILE") // For Windows compatibility
567 }
568 if homeDir == "" {
569 homeDir = os.Getenv("HOMEPATH") // Fallback for some environments
570 }
571 return homeDir
572}