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