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