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