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
46 if debug {
47 cfg.Options.Debug = true
48 }
49
50 // Init logs
51 log.Init(
52 filepath.Join(cfg.Options.DataDirectory, "logs", fmt.Sprintf("%s.log", appName)),
53 cfg.Options.Debug,
54 )
55
56 if err != nil {
57 return nil, fmt.Errorf("failed to load config: %w", err)
58 }
59
60 cfg.setDefaults(workingDir)
61
62 // Load known providers, this loads the config from fur
63 providers, err := LoadProviders(client.New())
64 if err != nil || len(providers) == 0 {
65 return nil, fmt.Errorf("failed to load providers: %w", err)
66 }
67
68 env := env.New()
69 // Configure providers
70 valueResolver := NewShellVariableResolver(env)
71 cfg.resolver = valueResolver
72 if err := cfg.configureProviders(env, valueResolver, providers); err != nil {
73 return nil, fmt.Errorf("failed to configure providers: %w", err)
74 }
75
76 if !cfg.IsConfigured() {
77 slog.Warn("No providers configured")
78 return cfg, nil
79 }
80
81 if err := cfg.configureSelectedModels(providers); err != nil {
82 return nil, fmt.Errorf("failed to configure selected models: %w", err)
83 }
84
85 // TODO: remove the agents concept from the config
86 agents := map[string]Agent{
87 "coder": {
88 ID: "coder",
89 Name: "Coder",
90 Description: "An agent that helps with executing coding tasks.",
91 Model: SelectedModelTypeLarge,
92 ContextPaths: cfg.Options.ContextPaths,
93 // All tools allowed
94 },
95 "task": {
96 ID: "task",
97 Name: "Task",
98 Description: "An agent that helps with searching for context and finding implementation details.",
99 Model: SelectedModelTypeLarge,
100 ContextPaths: cfg.Options.ContextPaths,
101 AllowedTools: []string{
102 "glob",
103 "grep",
104 "ls",
105 "sourcegraph",
106 "view",
107 },
108 // NO MCPs or LSPs by default
109 AllowedMCP: map[string][]string{},
110 AllowedLSP: []string{},
111 },
112 }
113 cfg.Agents = agents
114
115 return cfg, nil
116}
117
118func (cfg *Config) configureProviders(env env.Env, resolver VariableResolver, knownProviders []provider.Provider) error {
119 knownProviderNames := make(map[string]bool)
120 for _, p := range knownProviders {
121 knownProviderNames[string(p.ID)] = true
122 config, configExists := cfg.Providers[string(p.ID)]
123 // if the user configured a known provider we need to allow it to override a couple of parameters
124 if configExists {
125 if config.Disable {
126 slog.Debug("Skipping provider due to disable flag", "provider", p.ID)
127 delete(cfg.Providers, string(p.ID))
128 continue
129 }
130 if config.BaseURL != "" {
131 p.APIEndpoint = config.BaseURL
132 }
133 if config.APIKey != "" {
134 p.APIKey = config.APIKey
135 }
136 if len(config.Models) > 0 {
137 models := []provider.Model{}
138 seen := make(map[string]bool)
139
140 for _, model := range config.Models {
141 if seen[model.ID] {
142 continue
143 }
144 seen[model.ID] = true
145 models = append(models, model)
146 }
147 for _, model := range p.Models {
148 if seen[model.ID] {
149 continue
150 }
151 seen[model.ID] = true
152 models = append(models, model)
153 }
154
155 p.Models = models
156 }
157 }
158 prepared := ProviderConfig{
159 ID: string(p.ID),
160 BaseURL: p.APIEndpoint,
161 APIKey: p.APIKey,
162 Type: p.Type,
163 Disable: config.Disable,
164 ExtraHeaders: config.ExtraHeaders,
165 ExtraParams: make(map[string]string),
166 Models: p.Models,
167 }
168
169 switch p.ID {
170 // Handle specific providers that require additional configuration
171 case provider.InferenceProviderVertexAI:
172 if !hasVertexCredentials(env) {
173 if configExists {
174 slog.Warn("Skipping Vertex AI provider due to missing credentials")
175 delete(cfg.Providers, string(p.ID))
176 }
177 continue
178 }
179 prepared.ExtraParams["project"] = env.Get("GOOGLE_CLOUD_PROJECT")
180 prepared.ExtraParams["location"] = env.Get("GOOGLE_CLOUD_LOCATION")
181 case provider.InferenceProviderBedrock:
182 if !hasAWSCredentials(env) {
183 if configExists {
184 slog.Warn("Skipping Bedrock provider due to missing AWS credentials")
185 delete(cfg.Providers, string(p.ID))
186 }
187 continue
188 }
189 for _, model := range p.Models {
190 if !strings.HasPrefix(model.ID, "anthropic.") {
191 return fmt.Errorf("bedrock provider only supports anthropic models for now, found: %s", model.ID)
192 }
193 }
194 default:
195 // if the provider api or endpoint are missing we skip them
196 v, err := resolver.ResolveValue(p.APIKey)
197 if v == "" || err != nil {
198 if configExists {
199 slog.Warn("Skipping provider due to missing API key", "provider", p.ID)
200 delete(cfg.Providers, string(p.ID))
201 }
202 continue
203 }
204 }
205 cfg.Providers[string(p.ID)] = prepared
206 }
207
208 // validate the custom providers
209 for id, providerConfig := range cfg.Providers {
210 if knownProviderNames[id] {
211 continue
212 }
213
214 // Make sure the provider ID is set
215 providerConfig.ID = id
216 // default to OpenAI if not set
217 if providerConfig.Type == "" {
218 providerConfig.Type = provider.TypeOpenAI
219 }
220
221 if providerConfig.Disable {
222 slog.Debug("Skipping custom provider due to disable flag", "provider", id)
223 delete(cfg.Providers, id)
224 continue
225 }
226 if providerConfig.APIKey == "" {
227 slog.Warn("Skipping custom provider due to missing API key", "provider", id)
228 delete(cfg.Providers, id)
229 continue
230 }
231 if providerConfig.BaseURL == "" {
232 slog.Warn("Skipping custom provider due to missing API endpoint", "provider", id)
233 delete(cfg.Providers, id)
234 continue
235 }
236 if len(providerConfig.Models) == 0 {
237 slog.Warn("Skipping custom provider because the provider has no models", "provider", id)
238 delete(cfg.Providers, id)
239 continue
240 }
241 if providerConfig.Type != provider.TypeOpenAI {
242 slog.Warn("Skipping custom provider because the provider type is not supported", "provider", id, "type", providerConfig.Type)
243 delete(cfg.Providers, id)
244 continue
245 }
246
247 apiKey, err := resolver.ResolveValue(providerConfig.APIKey)
248 if apiKey == "" || err != nil {
249 slog.Warn("Skipping custom provider due to missing API key", "provider", id, "error", err)
250 delete(cfg.Providers, id)
251 continue
252 }
253 baseURL, err := resolver.ResolveValue(providerConfig.BaseURL)
254 if baseURL == "" || err != nil {
255 slog.Warn("Skipping custom provider due to missing API endpoint", "provider", id, "error", err)
256 delete(cfg.Providers, id)
257 continue
258 }
259
260 cfg.Providers[id] = providerConfig
261 }
262 return nil
263}
264
265func (cfg *Config) setDefaults(workingDir string) {
266 cfg.workingDir = workingDir
267 if cfg.Options == nil {
268 cfg.Options = &Options{}
269 }
270 if cfg.Options.TUI == nil {
271 cfg.Options.TUI = &TUIOptions{}
272 }
273 if cfg.Options.ContextPaths == nil {
274 cfg.Options.ContextPaths = []string{}
275 }
276 if cfg.Options.DataDirectory == "" {
277 cfg.Options.DataDirectory = filepath.Join(workingDir, defaultDataDirectory)
278 }
279 if cfg.Providers == nil {
280 cfg.Providers = make(map[string]ProviderConfig)
281 }
282 if cfg.Models == nil {
283 cfg.Models = make(map[SelectedModelType]SelectedModel)
284 }
285 if cfg.MCP == nil {
286 cfg.MCP = make(map[string]MCPConfig)
287 }
288 if cfg.LSP == nil {
289 cfg.LSP = make(map[string]LSPConfig)
290 }
291
292 // Add the default context paths if they are not already present
293 cfg.Options.ContextPaths = append(defaultContextPaths, cfg.Options.ContextPaths...)
294 slices.Sort(cfg.Options.ContextPaths)
295 cfg.Options.ContextPaths = slices.Compact(cfg.Options.ContextPaths)
296}
297
298func (cfg *Config) defaultModelSelection(knownProviders []provider.Provider) (largeModel SelectedModel, smallModel SelectedModel, err error) {
299 if len(knownProviders) == 0 && len(cfg.Providers) == 0 {
300 err = fmt.Errorf("no providers configured, please configure at least one provider")
301 return
302 }
303
304 // Use the first provider enabled based on the known providers order
305 // if no provider found that is known use the first provider configured
306 for _, p := range knownProviders {
307 providerConfig, ok := cfg.Providers[string(p.ID)]
308 if !ok || providerConfig.Disable {
309 continue
310 }
311 defaultLargeModel := cfg.GetModel(string(p.ID), p.DefaultLargeModelID)
312 if defaultLargeModel == nil {
313 err = fmt.Errorf("default large model %s not found for provider %s", p.DefaultLargeModelID, p.ID)
314 return
315 }
316 largeModel = SelectedModel{
317 Provider: string(p.ID),
318 Model: defaultLargeModel.ID,
319 MaxTokens: defaultLargeModel.DefaultMaxTokens,
320 }
321
322 defaultSmallModel := cfg.GetModel(string(p.ID), p.DefaultSmallModelID)
323 if defaultSmallModel == nil {
324 err = fmt.Errorf("default small model %s not found for provider %s", p.DefaultSmallModelID, p.ID)
325 }
326 smallModel = SelectedModel{
327 Provider: string(p.ID),
328 Model: defaultSmallModel.ID,
329 MaxTokens: defaultSmallModel.DefaultMaxTokens,
330 }
331 return
332 }
333
334 enabledProviders := cfg.EnabledProviders()
335 slices.SortFunc(enabledProviders, func(a, b ProviderConfig) int {
336 return strings.Compare(a.ID, b.ID)
337 })
338
339 if len(enabledProviders) == 0 {
340 err = fmt.Errorf("no providers configured, please configure at least one provider")
341 return
342 }
343
344 providerConfig := enabledProviders[0]
345 if len(providerConfig.Models) == 0 {
346 err = fmt.Errorf("provider %s has no models configured", providerConfig.ID)
347 return
348 }
349 defaultLargeModel := cfg.GetModel(providerConfig.ID, providerConfig.Models[0].ID)
350 largeModel = SelectedModel{
351 Provider: providerConfig.ID,
352 Model: defaultLargeModel.ID,
353 MaxTokens: defaultLargeModel.DefaultMaxTokens,
354 }
355 defaultSmallModel := cfg.GetModel(providerConfig.ID, providerConfig.Models[0].ID)
356 smallModel = SelectedModel{
357 Provider: providerConfig.ID,
358 Model: defaultSmallModel.ID,
359 MaxTokens: defaultSmallModel.DefaultMaxTokens,
360 }
361 return
362}
363
364func (cfg *Config) configureSelectedModels(knownProviders []provider.Provider) error {
365 large, small, err := cfg.defaultModelSelection(knownProviders)
366 if err != nil {
367 return fmt.Errorf("failed to select default models: %w", err)
368 }
369
370 largeModelSelected, largeModelConfigured := cfg.Models[SelectedModelTypeLarge]
371 if largeModelConfigured {
372 if largeModelSelected.Model != "" {
373 large.Model = largeModelSelected.Model
374 }
375 if largeModelSelected.Provider != "" {
376 large.Provider = largeModelSelected.Provider
377 }
378 model := cfg.GetModel(large.Provider, large.Model)
379 if model == nil {
380 return fmt.Errorf("large model %s not found for provider %s", large.Model, large.Provider)
381 }
382 if largeModelSelected.MaxTokens > 0 {
383 large.MaxTokens = largeModelSelected.MaxTokens
384 } else {
385 large.MaxTokens = model.DefaultMaxTokens
386 }
387 large.ReasoningEffort = largeModelSelected.ReasoningEffort
388 large.Think = largeModelSelected.Think
389 }
390 smallModelSelected, smallModelConfigured := cfg.Models[SelectedModelTypeSmall]
391 if smallModelConfigured {
392 if smallModelSelected.Model != "" {
393 small.Model = smallModelSelected.Model
394 }
395 if smallModelSelected.Provider != "" {
396 small.Provider = smallModelSelected.Provider
397 }
398
399 model := cfg.GetModel(small.Provider, small.Model)
400 if model == nil {
401 return fmt.Errorf("large model %s not found for provider %s", large.Model, large.Provider)
402 }
403 if smallModelSelected.MaxTokens > 0 {
404 small.MaxTokens = smallModelSelected.MaxTokens
405 } else {
406 small.MaxTokens = model.DefaultMaxTokens
407 }
408 small.ReasoningEffort = smallModelSelected.ReasoningEffort
409 small.Think = smallModelSelected.Think
410 }
411
412 // validate the selected models
413 largeModel := cfg.GetModel(large.Provider, large.Model)
414 if largeModel == nil {
415 return fmt.Errorf("large model %s not found for provider %s", large.Model, large.Provider)
416 }
417 smallModel := cfg.GetModel(small.Provider, small.Model)
418 if smallModel == nil {
419 return fmt.Errorf("small model %s not found for provider %s", small.Model, small.Provider)
420 }
421 cfg.Models[SelectedModelTypeLarge] = large
422 cfg.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 nil, fmt.Errorf("no configuration readers provided")
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, "crush")
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)
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)
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)
523 }
524
525 return filepath.Join(os.Getenv("HOME"), ".local", "share", appName, fmt.Sprintf("%s.json", appName))
526}