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