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.setDefaults(workingDir)
50
51 if debug {
52 cfg.Options.Debug = true
53 }
54
55 // Setup logs
56 log.Setup(
57 filepath.Join(cfg.Options.DataDirectory, "logs", fmt.Sprintf("%s.log", appName)),
58 cfg.Options.Debug,
59 )
60
61 // Load known providers, this loads the config from fur
62 providers, err := LoadProviders(client.New())
63 if err != nil || len(providers) == 0 {
64 return nil, fmt.Errorf("failed to load providers: %w", err)
65 }
66
67 env := env.New()
68 // Configure providers
69 valueResolver := NewShellVariableResolver(env)
70 cfg.resolver = valueResolver
71 if err := cfg.configureProviders(env, valueResolver, providers); err != nil {
72 return nil, fmt.Errorf("failed to configure providers: %w", err)
73 }
74
75 if !cfg.IsConfigured() {
76 slog.Warn("No providers configured")
77 return cfg, nil
78 }
79
80 if err := cfg.configureSelectedModels(providers); err != nil {
81 return nil, fmt.Errorf("failed to configure selected models: %w", err)
82 }
83
84 // TODO: remove the agents concept from the config
85 agents := map[string]Agent{
86 "coder": {
87 ID: "coder",
88 Name: "Coder",
89 Description: "An agent that helps with executing coding tasks.",
90 Model: SelectedModelTypeLarge,
91 ContextPaths: cfg.Options.ContextPaths,
92 // All tools allowed
93 },
94 "task": {
95 ID: "task",
96 Name: "Task",
97 Description: "An agent that helps with searching for context and finding implementation details.",
98 Model: SelectedModelTypeLarge,
99 ContextPaths: cfg.Options.ContextPaths,
100 AllowedTools: []string{
101 "glob",
102 "grep",
103 "ls",
104 "sourcegraph",
105 "view",
106 },
107 // NO MCPs or LSPs by default
108 AllowedMCP: map[string][]string{},
109 AllowedLSP: []string{},
110 },
111 }
112 cfg.Agents = agents
113
114 return cfg, nil
115}
116
117func (cfg *Config) configureProviders(env env.Env, resolver VariableResolver, knownProviders []provider.Provider) error {
118 knownProviderNames := make(map[string]bool)
119 for _, p := range knownProviders {
120 knownProviderNames[string(p.ID)] = true
121 config, configExists := cfg.Providers[string(p.ID)]
122 // if the user configured a known provider we need to allow it to override a couple of parameters
123 if configExists {
124 if config.Disable {
125 slog.Debug("Skipping provider due to disable flag", "provider", p.ID)
126 delete(cfg.Providers, string(p.ID))
127 continue
128 }
129 if config.BaseURL != "" {
130 p.APIEndpoint = config.BaseURL
131 }
132 if config.APIKey != "" {
133 p.APIKey = config.APIKey
134 }
135 if len(config.Models) > 0 {
136 models := []provider.Model{}
137 seen := make(map[string]bool)
138
139 for _, model := range config.Models {
140 if seen[model.ID] {
141 continue
142 }
143 seen[model.ID] = true
144 if model.Model == "" {
145 model.Model = model.ID
146 }
147 models = append(models, model)
148 }
149 for _, model := range p.Models {
150 if seen[model.ID] {
151 continue
152 }
153 seen[model.ID] = true
154 if model.Model == "" {
155 model.Model = model.ID
156 }
157 models = append(models, model)
158 }
159
160 p.Models = models
161 }
162 }
163 prepared := ProviderConfig{
164 ID: string(p.ID),
165 BaseURL: p.APIEndpoint,
166 APIKey: p.APIKey,
167 Type: p.Type,
168 Disable: config.Disable,
169 ExtraHeaders: config.ExtraHeaders,
170 ExtraParams: make(map[string]string),
171 Models: p.Models,
172 }
173
174 switch p.ID {
175 // Handle specific providers that require additional configuration
176 case provider.InferenceProviderVertexAI:
177 if !hasVertexCredentials(env) {
178 if configExists {
179 slog.Warn("Skipping Vertex AI provider due to missing credentials")
180 delete(cfg.Providers, string(p.ID))
181 }
182 continue
183 }
184 prepared.ExtraParams["project"] = env.Get("GOOGLE_CLOUD_PROJECT")
185 prepared.ExtraParams["location"] = env.Get("GOOGLE_CLOUD_LOCATION")
186 case provider.InferenceProviderBedrock:
187 if !hasAWSCredentials(env) {
188 if configExists {
189 slog.Warn("Skipping Bedrock provider due to missing AWS credentials")
190 delete(cfg.Providers, string(p.ID))
191 }
192 continue
193 }
194 for _, model := range p.Models {
195 if !strings.HasPrefix(model.ID, "anthropic.") {
196 return fmt.Errorf("bedrock provider only supports anthropic models for now, found: %s", model.ID)
197 }
198 }
199 default:
200 // if the provider api or endpoint are missing we skip them
201 v, err := resolver.ResolveValue(p.APIKey)
202 if v == "" || err != nil {
203 if configExists {
204 slog.Warn("Skipping provider due to missing API key", "provider", p.ID)
205 delete(cfg.Providers, string(p.ID))
206 }
207 continue
208 }
209 }
210 cfg.Providers[string(p.ID)] = prepared
211 }
212
213 // validate the custom providers
214 for id, providerConfig := range cfg.Providers {
215 if knownProviderNames[id] {
216 continue
217 }
218
219 // Make sure the provider ID is set
220 providerConfig.ID = id
221 // default to OpenAI if not set
222 if providerConfig.Type == "" {
223 providerConfig.Type = provider.TypeOpenAI
224 }
225
226 if providerConfig.Disable {
227 slog.Debug("Skipping custom provider due to disable flag", "provider", id)
228 delete(cfg.Providers, id)
229 continue
230 }
231 if providerConfig.APIKey == "" {
232 slog.Warn("Skipping custom provider due to missing API key", "provider", id)
233 delete(cfg.Providers, id)
234 continue
235 }
236 if providerConfig.BaseURL == "" {
237 slog.Warn("Skipping custom provider due to missing API endpoint", "provider", id)
238 delete(cfg.Providers, id)
239 continue
240 }
241 if len(providerConfig.Models) == 0 {
242 slog.Warn("Skipping custom provider because the provider has no models", "provider", id)
243 delete(cfg.Providers, id)
244 continue
245 }
246 if providerConfig.Type != provider.TypeOpenAI {
247 slog.Warn("Skipping custom provider because the provider type is not supported", "provider", id, "type", providerConfig.Type)
248 delete(cfg.Providers, id)
249 continue
250 }
251
252 apiKey, err := resolver.ResolveValue(providerConfig.APIKey)
253 if apiKey == "" || err != nil {
254 slog.Warn("Skipping custom provider due to missing API key", "provider", id, "error", err)
255 delete(cfg.Providers, id)
256 continue
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 large, small, err := cfg.defaultModelSelection(knownProviders)
373 if err != nil {
374 return fmt.Errorf("failed to select default models: %w", err)
375 }
376
377 largeModelSelected, largeModelConfigured := cfg.Models[SelectedModelTypeLarge]
378 if largeModelConfigured {
379 if largeModelSelected.Model != "" {
380 large.Model = largeModelSelected.Model
381 }
382 if largeModelSelected.Provider != "" {
383 large.Provider = largeModelSelected.Provider
384 }
385 model := cfg.GetModel(large.Provider, large.Model)
386 if model == nil {
387 return fmt.Errorf("large model %s not found for provider %s", large.Model, large.Provider)
388 }
389 if largeModelSelected.MaxTokens > 0 {
390 large.MaxTokens = largeModelSelected.MaxTokens
391 } else {
392 large.MaxTokens = model.DefaultMaxTokens
393 }
394 if largeModelSelected.ReasoningEffort != "" {
395 large.ReasoningEffort = largeModelSelected.ReasoningEffort
396 }
397 large.Think = largeModelSelected.Think
398 }
399 smallModelSelected, smallModelConfigured := cfg.Models[SelectedModelTypeSmall]
400 if smallModelConfigured {
401 if smallModelSelected.Model != "" {
402 small.Model = smallModelSelected.Model
403 }
404 if smallModelSelected.Provider != "" {
405 small.Provider = smallModelSelected.Provider
406 }
407
408 model := cfg.GetModel(small.Provider, small.Model)
409 if model == nil {
410 return fmt.Errorf("large model %s not found for provider %s", large.Model, large.Provider)
411 }
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 // validate the selected models
422 largeModel := cfg.GetModel(large.Provider, large.Model)
423 if largeModel == nil {
424 return fmt.Errorf("large model %s not found for provider %s", large.Model, large.Provider)
425 }
426 smallModel := cfg.GetModel(small.Provider, small.Model)
427 if smallModel == nil {
428 return fmt.Errorf("small model %s not found for provider %s", small.Model, small.Provider)
429 }
430 cfg.Models[SelectedModelTypeLarge] = large
431 cfg.Models[SelectedModelTypeSmall] = small
432 return nil
433}
434
435func loadFromConfigPaths(configPaths []string) (*Config, error) {
436 var configs []io.Reader
437
438 for _, path := range configPaths {
439 fd, err := os.Open(path)
440 if err != nil {
441 if os.IsNotExist(err) {
442 continue
443 }
444 return nil, fmt.Errorf("failed to open config file %s: %w", path, err)
445 }
446 defer fd.Close()
447
448 configs = append(configs, fd)
449 }
450
451 return loadFromReaders(configs)
452}
453
454func loadFromReaders(readers []io.Reader) (*Config, error) {
455 if len(readers) == 0 {
456 return &Config{}, nil
457 }
458
459 merged, err := Merge(readers)
460 if err != nil {
461 return nil, fmt.Errorf("failed to merge configuration readers: %w", err)
462 }
463
464 return LoadReader(merged)
465}
466
467func hasVertexCredentials(env env.Env) bool {
468 useVertex := env.Get("GOOGLE_GENAI_USE_VERTEXAI") == "true"
469 hasProject := env.Get("GOOGLE_CLOUD_PROJECT") != ""
470 hasLocation := env.Get("GOOGLE_CLOUD_LOCATION") != ""
471 return useVertex && hasProject && hasLocation
472}
473
474func hasAWSCredentials(env env.Env) bool {
475 if env.Get("AWS_ACCESS_KEY_ID") != "" && env.Get("AWS_SECRET_ACCESS_KEY") != "" {
476 return true
477 }
478
479 if env.Get("AWS_PROFILE") != "" || env.Get("AWS_DEFAULT_PROFILE") != "" {
480 return true
481 }
482
483 if env.Get("AWS_REGION") != "" || env.Get("AWS_DEFAULT_REGION") != "" {
484 return true
485 }
486
487 if env.Get("AWS_CONTAINER_CREDENTIALS_RELATIVE_URI") != "" ||
488 env.Get("AWS_CONTAINER_CREDENTIALS_FULL_URI") != "" {
489 return true
490 }
491
492 return false
493}
494
495func globalConfig() string {
496 xdgConfigHome := os.Getenv("XDG_CONFIG_HOME")
497 if xdgConfigHome != "" {
498 return filepath.Join(xdgConfigHome, appName, fmt.Sprintf("%s.json", appName))
499 }
500
501 // return the path to the main config directory
502 // for windows, it should be in `%LOCALAPPDATA%/crush/`
503 // for linux and macOS, it should be in `$HOME/.config/crush/`
504 if runtime.GOOS == "windows" {
505 localAppData := os.Getenv("LOCALAPPDATA")
506 if localAppData == "" {
507 localAppData = filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local")
508 }
509 return filepath.Join(localAppData, appName, fmt.Sprintf("%s.json", appName))
510 }
511
512 return filepath.Join(os.Getenv("HOME"), ".config", appName, fmt.Sprintf("%s.json", appName))
513}
514
515// globalConfigData returns the path to the main data directory for the application.
516// this config is used when the app overrides configurations instead of updating the global config.
517func globalConfigData() string {
518 xdgDataHome := os.Getenv("XDG_DATA_HOME")
519 if xdgDataHome != "" {
520 return filepath.Join(xdgDataHome, appName, fmt.Sprintf("%s.json", appName))
521 }
522
523 // return the path to the main data directory
524 // for windows, it should be in `%LOCALAPPDATA%/crush/`
525 // for linux and macOS, it should be in `$HOME/.local/share/crush/`
526 if runtime.GOOS == "windows" {
527 localAppData := os.Getenv("LOCALAPPDATA")
528 if localAppData == "" {
529 localAppData = filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local")
530 }
531 return filepath.Join(localAppData, appName, fmt.Sprintf("%s.json", appName))
532 }
533
534 return filepath.Join(os.Getenv("HOME"), ".local", "share", appName, fmt.Sprintf("%s.json", appName))
535}