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