1package config
2
3import (
4 "encoding/json"
5 "fmt"
6 "io"
7 "os"
8 "path/filepath"
9 "runtime"
10 "slices"
11 "strings"
12
13 "github.com/charmbracelet/crush/internal/env"
14 "github.com/charmbracelet/crush/internal/fur/client"
15 "github.com/charmbracelet/crush/internal/fur/provider"
16 "github.com/charmbracelet/crush/internal/log"
17 "golang.org/x/exp/slog"
18)
19
20// LoadReader config via io.Reader.
21func LoadReader(fd io.Reader) (*Config, error) {
22 data, err := io.ReadAll(fd)
23 if err != nil {
24 return nil, err
25 }
26
27 var config Config
28 err = json.Unmarshal(data, &config)
29 if err != nil {
30 return nil, err
31 }
32 return &config, err
33}
34
35// Load loads the configuration from the default paths.
36func Load(workingDir string, debug bool) (*Config, error) {
37 // uses default config paths
38 configPaths := []string{
39 globalConfig(),
40 GlobalConfigData(),
41 filepath.Join(workingDir, fmt.Sprintf("%s.json", appName)),
42 filepath.Join(workingDir, fmt.Sprintf(".%s.json", appName)),
43 }
44 cfg, err := loadFromConfigPaths(configPaths)
45 if err != nil {
46 return nil, fmt.Errorf("failed to load config from paths %v: %w", configPaths, err)
47 }
48
49 cfg.dataConfigDir = GlobalConfigData()
50
51 cfg.setDefaults(workingDir)
52
53 if debug {
54 cfg.Options.Debug = true
55 }
56
57 // Init logs
58 log.Init(
59 filepath.Join(cfg.Options.DataDirectory, "logs", fmt.Sprintf("%s.log", appName)),
60 cfg.Options.Debug,
61 )
62
63 if err != nil {
64 return nil, fmt.Errorf("failed to load config: %w", err)
65 }
66
67 // Load known providers, this loads the config from fur
68 providers, err := LoadProviders(client.New())
69 if err != nil || len(providers) == 0 {
70 return nil, fmt.Errorf("failed to load providers: %w", err)
71 }
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
90 // TODO: remove the agents concept from the config
91 agents := map[string]Agent{
92 "coder": {
93 ID: "coder",
94 Name: "Coder",
95 Description: "An agent that helps with executing coding tasks.",
96 Model: SelectedModelTypeLarge,
97 ContextPaths: cfg.Options.ContextPaths,
98 // All tools allowed
99 },
100 "task": {
101 ID: "task",
102 Name: "Task",
103 Description: "An agent that helps with searching for context and finding implementation details.",
104 Model: SelectedModelTypeLarge,
105 ContextPaths: cfg.Options.ContextPaths,
106 AllowedTools: []string{
107 "glob",
108 "grep",
109 "ls",
110 "sourcegraph",
111 "view",
112 },
113 // NO MCPs or LSPs by default
114 AllowedMCP: map[string][]string{},
115 AllowedLSP: []string{},
116 },
117 }
118 cfg.Agents = agents
119
120 return cfg, nil
121}
122
123func (cfg *Config) configureProviders(env env.Env, resolver VariableResolver, knownProviders []provider.Provider) error {
124 knownProviderNames := make(map[string]bool)
125 for _, p := range knownProviders {
126 knownProviderNames[string(p.ID)] = true
127 config, configExists := cfg.Providers[string(p.ID)]
128 // if the user configured a known provider we need to allow it to override a couple of parameters
129 if configExists {
130 if config.Disable {
131 slog.Debug("Skipping provider due to disable flag", "provider", p.ID)
132 delete(cfg.Providers, string(p.ID))
133 continue
134 }
135 if config.BaseURL != "" {
136 p.APIEndpoint = config.BaseURL
137 }
138 if config.APIKey != "" {
139 p.APIKey = config.APIKey
140 }
141 if len(config.Models) > 0 {
142 models := []provider.Model{}
143 seen := make(map[string]bool)
144
145 for _, model := range config.Models {
146 if seen[model.ID] {
147 continue
148 }
149 seen[model.ID] = true
150 models = append(models, model)
151 }
152 for _, model := range p.Models {
153 if seen[model.ID] {
154 continue
155 }
156 seen[model.ID] = true
157 models = append(models, model)
158 }
159
160 p.Models = models
161 }
162 }
163 prepared := ProviderConfig{
164 ID: string(p.ID),
165 Name: p.Name,
166 BaseURL: p.APIEndpoint,
167 APIKey: p.APIKey,
168 Type: p.Type,
169 Disable: config.Disable,
170 ExtraHeaders: config.ExtraHeaders,
171 ExtraParams: make(map[string]string),
172 Models: p.Models,
173 }
174
175 switch p.ID {
176 // Handle specific providers that require additional configuration
177 case provider.InferenceProviderVertexAI:
178 if !hasVertexCredentials(env) {
179 if configExists {
180 slog.Warn("Skipping Vertex AI provider due to missing credentials")
181 delete(cfg.Providers, string(p.ID))
182 }
183 continue
184 }
185 prepared.ExtraParams["project"] = env.Get("GOOGLE_CLOUD_PROJECT")
186 prepared.ExtraParams["location"] = env.Get("GOOGLE_CLOUD_LOCATION")
187 case provider.InferenceProviderBedrock:
188 if !hasAWSCredentials(env) {
189 if configExists {
190 slog.Warn("Skipping Bedrock provider due to missing AWS credentials")
191 delete(cfg.Providers, string(p.ID))
192 }
193 continue
194 }
195 for _, model := range p.Models {
196 if !strings.HasPrefix(model.ID, "anthropic.") {
197 return fmt.Errorf("bedrock provider only supports anthropic models for now, found: %s", model.ID)
198 }
199 }
200 default:
201 // if the provider api or endpoint are missing we skip them
202 v, err := resolver.ResolveValue(p.APIKey)
203 if v == "" || err != nil {
204 if configExists {
205 slog.Warn("Skipping provider due to missing API key", "provider", p.ID)
206 delete(cfg.Providers, string(p.ID))
207 }
208 continue
209 }
210 }
211 cfg.Providers[string(p.ID)] = prepared
212 }
213
214 // validate the custom providers
215 for id, providerConfig := range cfg.Providers {
216 if knownProviderNames[id] {
217 continue
218 }
219
220 // Make sure the provider ID is set
221 providerConfig.ID = id
222 if providerConfig.Name == "" {
223 providerConfig.Name = id // Use ID as name if not set
224 }
225 // default to OpenAI if not set
226 if providerConfig.Type == "" {
227 providerConfig.Type = provider.TypeOpenAI
228 }
229
230 if providerConfig.Disable {
231 slog.Debug("Skipping custom provider due to disable flag", "provider", id)
232 delete(cfg.Providers, id)
233 continue
234 }
235 if providerConfig.APIKey == "" {
236 slog.Warn("Provider is missing API key, this might be OK for local providers", "provider", id)
237 }
238 if providerConfig.BaseURL == "" {
239 slog.Warn("Skipping custom provider due to missing API endpoint", "provider", id)
240 delete(cfg.Providers, id)
241 continue
242 }
243 if len(providerConfig.Models) == 0 {
244 slog.Warn("Skipping custom provider because the provider has no models", "provider", id)
245 delete(cfg.Providers, id)
246 continue
247 }
248 if providerConfig.Type != provider.TypeOpenAI {
249 slog.Warn("Skipping custom provider because the provider type is not supported", "provider", id, "type", providerConfig.Type)
250 delete(cfg.Providers, id)
251 continue
252 }
253
254 apiKey, err := resolver.ResolveValue(providerConfig.APIKey)
255 if apiKey == "" || err != nil {
256 slog.Warn("Provider is missing API key, this might be OK for local providers", "provider", id)
257 }
258 baseURL, err := resolver.ResolveValue(providerConfig.BaseURL)
259 if baseURL == "" || err != nil {
260 slog.Warn("Skipping custom provider due to missing API endpoint", "provider", id, "error", err)
261 delete(cfg.Providers, id)
262 continue
263 }
264
265 cfg.Providers[id] = providerConfig
266 }
267 return nil
268}
269
270func (cfg *Config) setDefaults(workingDir string) {
271 cfg.workingDir = workingDir
272 if cfg.Options == nil {
273 cfg.Options = &Options{}
274 }
275 if cfg.Options.TUI == nil {
276 cfg.Options.TUI = &TUIOptions{}
277 }
278 if cfg.Options.ContextPaths == nil {
279 cfg.Options.ContextPaths = []string{}
280 }
281 if cfg.Options.DataDirectory == "" {
282 cfg.Options.DataDirectory = filepath.Join(workingDir, defaultDataDirectory)
283 }
284 if cfg.Providers == nil {
285 cfg.Providers = make(map[string]ProviderConfig)
286 }
287 if cfg.Models == nil {
288 cfg.Models = make(map[SelectedModelType]SelectedModel)
289 }
290 if cfg.MCP == nil {
291 cfg.MCP = make(map[string]MCPConfig)
292 }
293 if cfg.LSP == nil {
294 cfg.LSP = make(map[string]LSPConfig)
295 }
296
297 // Add the default context paths if they are not already present
298 cfg.Options.ContextPaths = append(defaultContextPaths, cfg.Options.ContextPaths...)
299 slices.Sort(cfg.Options.ContextPaths)
300 cfg.Options.ContextPaths = slices.Compact(cfg.Options.ContextPaths)
301}
302
303func (cfg *Config) defaultModelSelection(knownProviders []provider.Provider) (largeModel SelectedModel, smallModel SelectedModel, err error) {
304 if len(knownProviders) == 0 && len(cfg.Providers) == 0 {
305 err = fmt.Errorf("no providers configured, please configure at least one provider")
306 return
307 }
308
309 // Use the first provider enabled based on the known providers order
310 // if no provider found that is known use the first provider configured
311 for _, p := range knownProviders {
312 providerConfig, ok := cfg.Providers[string(p.ID)]
313 if !ok || providerConfig.Disable {
314 continue
315 }
316 defaultLargeModel := cfg.GetModel(string(p.ID), p.DefaultLargeModelID)
317 if defaultLargeModel == nil {
318 err = fmt.Errorf("default large model %s not found for provider %s", p.DefaultLargeModelID, p.ID)
319 return
320 }
321 largeModel = SelectedModel{
322 Provider: string(p.ID),
323 Model: defaultLargeModel.ID,
324 MaxTokens: defaultLargeModel.DefaultMaxTokens,
325 ReasoningEffort: defaultLargeModel.DefaultReasoningEffort,
326 }
327
328 defaultSmallModel := cfg.GetModel(string(p.ID), p.DefaultSmallModelID)
329 if defaultSmallModel == nil {
330 err = fmt.Errorf("default small model %s not found for provider %s", p.DefaultSmallModelID, p.ID)
331 }
332 smallModel = SelectedModel{
333 Provider: string(p.ID),
334 Model: defaultSmallModel.ID,
335 MaxTokens: defaultSmallModel.DefaultMaxTokens,
336 ReasoningEffort: defaultSmallModel.DefaultReasoningEffort,
337 }
338 return
339 }
340
341 enabledProviders := cfg.EnabledProviders()
342 slices.SortFunc(enabledProviders, func(a, b ProviderConfig) int {
343 return strings.Compare(a.ID, b.ID)
344 })
345
346 if len(enabledProviders) == 0 {
347 err = fmt.Errorf("no providers configured, please configure at least one provider")
348 return
349 }
350
351 providerConfig := enabledProviders[0]
352 if len(providerConfig.Models) == 0 {
353 err = fmt.Errorf("provider %s has no models configured", providerConfig.ID)
354 return
355 }
356 defaultLargeModel := cfg.GetModel(providerConfig.ID, providerConfig.Models[0].ID)
357 largeModel = SelectedModel{
358 Provider: providerConfig.ID,
359 Model: defaultLargeModel.ID,
360 MaxTokens: defaultLargeModel.DefaultMaxTokens,
361 }
362 defaultSmallModel := cfg.GetModel(providerConfig.ID, providerConfig.Models[0].ID)
363 smallModel = SelectedModel{
364 Provider: providerConfig.ID,
365 Model: defaultSmallModel.ID,
366 MaxTokens: defaultSmallModel.DefaultMaxTokens,
367 }
368 return
369}
370
371func (cfg *Config) configureSelectedModels(knownProviders []provider.Provider) error {
372 defaultLarge, defaultSmall, err := cfg.defaultModelSelection(knownProviders)
373 if err != nil {
374 return fmt.Errorf("failed to select default models: %w", err)
375 }
376 large, small := defaultLarge, defaultSmall
377
378 largeModelSelected, largeModelConfigured := cfg.Models[SelectedModelTypeLarge]
379 if largeModelConfigured {
380 if largeModelSelected.Model != "" {
381 large.Model = largeModelSelected.Model
382 }
383 if largeModelSelected.Provider != "" {
384 large.Provider = largeModelSelected.Provider
385 }
386 model := cfg.GetModel(large.Provider, large.Model)
387 slog.Info("Configuring selected large model", "provider", large.Provider, "model", large.Model)
388 slog.Info("MOdel configured", "model", model)
389 if model == nil {
390 large = defaultLarge
391 // override the model type to large
392 err := cfg.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 := cfg.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 := cfg.GetModel(small.Provider, small.Model)
418 if model == nil {
419 small = defaultSmall
420 // override the model type to small
421 err := cfg.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 cfg.Models[SelectedModelTypeLarge] = large
436 cfg.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 useVertex := env.Get("GOOGLE_GENAI_USE_VERTEXAI") == "true"
474 hasProject := env.Get("GOOGLE_CLOUD_PROJECT") != ""
475 hasLocation := env.Get("GOOGLE_CLOUD_LOCATION") != ""
476 return useVertex && hasProject && hasLocation
477}
478
479func hasAWSCredentials(env env.Env) bool {
480 if env.Get("AWS_ACCESS_KEY_ID") != "" && env.Get("AWS_SECRET_ACCESS_KEY") != "" {
481 return true
482 }
483
484 if env.Get("AWS_PROFILE") != "" || env.Get("AWS_DEFAULT_PROFILE") != "" {
485 return true
486 }
487
488 if env.Get("AWS_REGION") != "" || env.Get("AWS_DEFAULT_REGION") != "" {
489 return true
490 }
491
492 if env.Get("AWS_CONTAINER_CREDENTIALS_RELATIVE_URI") != "" ||
493 env.Get("AWS_CONTAINER_CREDENTIALS_FULL_URI") != "" {
494 return true
495 }
496
497 return false
498}
499
500func globalConfig() string {
501 xdgConfigHome := os.Getenv("XDG_CONFIG_HOME")
502 if xdgConfigHome != "" {
503 return filepath.Join(xdgConfigHome, appName, fmt.Sprintf("%s.json", appName))
504 }
505
506 // return the path to the main config directory
507 // for windows, it should be in `%LOCALAPPDATA%/crush/`
508 // for linux and macOS, it should be in `$HOME/.config/crush/`
509 if runtime.GOOS == "windows" {
510 localAppData := os.Getenv("LOCALAPPDATA")
511 if localAppData == "" {
512 localAppData = filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local")
513 }
514 return filepath.Join(localAppData, appName, fmt.Sprintf("%s.json", appName))
515 }
516
517 return filepath.Join(os.Getenv("HOME"), ".config", appName, fmt.Sprintf("%s.json", appName))
518}
519
520// GlobalConfigData returns the path to the main data directory for the application.
521// this config is used when the app overrides configurations instead of updating the global config.
522func GlobalConfigData() string {
523 xdgDataHome := os.Getenv("XDG_DATA_HOME")
524 if xdgDataHome != "" {
525 return filepath.Join(xdgDataHome, appName, fmt.Sprintf("%s.json", appName))
526 }
527
528 // return the path to the main data directory
529 // for windows, it should be in `%LOCALAPPDATA%/crush/`
530 // for linux and macOS, it should be in `$HOME/.local/share/crush/`
531 if runtime.GOOS == "windows" {
532 localAppData := os.Getenv("LOCALAPPDATA")
533 if localAppData == "" {
534 localAppData = filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local")
535 }
536 return filepath.Join(localAppData, appName, fmt.Sprintf("%s.json", appName))
537 }
538
539 return filepath.Join(os.Getenv("HOME"), ".local", "share", appName, fmt.Sprintf("%s.json", appName))
540}
541
542func HomeDir() string {
543 homeDir := os.Getenv("HOME")
544 if homeDir == "" {
545 homeDir = os.Getenv("USERPROFILE") // For Windows compatibility
546 }
547 if homeDir == "" {
548 homeDir = os.Getenv("HOMEPATH") // Fallback for some environments
549 }
550 return homeDir
551}