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