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