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