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