load.go 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550
  1. package config
  2. import (
  3. "encoding/json"
  4. "fmt"
  5. "io"
  6. "log/slog"
  7. "maps"
  8. "os"
  9. "path/filepath"
  10. "runtime"
  11. "slices"
  12. "strings"
  13. "github.com/charmbracelet/catwalk/pkg/catwalk"
  14. "github.com/charmbracelet/crush/internal/csync"
  15. "github.com/charmbracelet/crush/internal/env"
  16. "github.com/charmbracelet/crush/internal/log"
  17. )
  18. const defaultCatwalkURL = "https://catwalk.charm.sh"
  19. // LoadReader config via io.Reader.
  20. func LoadReader(fd io.Reader) (*Config, error) {
  21. data, err := io.ReadAll(fd)
  22. if err != nil {
  23. return nil, err
  24. }
  25. var config Config
  26. err = json.Unmarshal(data, &config)
  27. if err != nil {
  28. return nil, err
  29. }
  30. return &config, err
  31. }
  32. // Load loads the configuration from the default paths.
  33. func Load(workingDir string, debug bool) (*Config, error) {
  34. // uses default config paths
  35. configPaths := []string{
  36. globalConfig(),
  37. GlobalConfigData(),
  38. filepath.Join(workingDir, fmt.Sprintf("%s.json", appName)),
  39. filepath.Join(workingDir, fmt.Sprintf(".%s.json", appName)),
  40. }
  41. cfg, err := loadFromConfigPaths(configPaths)
  42. if err != nil {
  43. return nil, fmt.Errorf("failed to load config from paths %v: %w", configPaths, err)
  44. }
  45. cfg.dataConfigDir = GlobalConfigData()
  46. cfg.setDefaults(workingDir)
  47. if debug {
  48. cfg.Options.Debug = true
  49. }
  50. // Setup logs
  51. log.Setup(
  52. filepath.Join(cfg.Options.DataDirectory, "logs", fmt.Sprintf("%s.log", appName)),
  53. cfg.Options.Debug,
  54. )
  55. // Load known providers, this loads the config from catwalk
  56. providers, err := Providers()
  57. if err != nil || len(providers) == 0 {
  58. return nil, fmt.Errorf("failed to load providers: %w", err)
  59. }
  60. cfg.knownProviders = providers
  61. env := env.New()
  62. // Configure providers
  63. valueResolver := NewShellVariableResolver(env)
  64. cfg.resolver = valueResolver
  65. if err := cfg.configureProviders(env, valueResolver, providers); err != nil {
  66. return nil, fmt.Errorf("failed to configure providers: %w", err)
  67. }
  68. if !cfg.IsConfigured() {
  69. slog.Warn("No providers configured")
  70. return cfg, nil
  71. }
  72. if err := cfg.configureSelectedModels(providers); err != nil {
  73. return nil, fmt.Errorf("failed to configure selected models: %w", err)
  74. }
  75. cfg.SetupAgents()
  76. return cfg, nil
  77. }
  78. func (c *Config) configureProviders(env env.Env, resolver VariableResolver, knownProviders []catwalk.Provider) error {
  79. knownProviderNames := make(map[string]bool)
  80. for _, p := range knownProviders {
  81. knownProviderNames[string(p.ID)] = true
  82. config, configExists := c.Providers.Get(string(p.ID))
  83. // if the user configured a known provider we need to allow it to override a couple of parameters
  84. if configExists {
  85. if config.Disable {
  86. slog.Debug("Skipping provider due to disable flag", "provider", p.ID)
  87. c.Providers.Del(string(p.ID))
  88. continue
  89. }
  90. if config.BaseURL != "" {
  91. p.APIEndpoint = config.BaseURL
  92. }
  93. if config.APIKey != "" {
  94. p.APIKey = config.APIKey
  95. }
  96. if len(config.Models) > 0 {
  97. models := []catwalk.Model{}
  98. seen := make(map[string]bool)
  99. for _, model := range config.Models {
  100. if seen[model.ID] {
  101. continue
  102. }
  103. seen[model.ID] = true
  104. if model.Name == "" {
  105. model.Name = model.ID
  106. }
  107. models = append(models, model)
  108. }
  109. for _, model := range p.Models {
  110. if seen[model.ID] {
  111. continue
  112. }
  113. seen[model.ID] = true
  114. if model.Name == "" {
  115. model.Name = model.ID
  116. }
  117. models = append(models, model)
  118. }
  119. p.Models = models
  120. }
  121. }
  122. headers := map[string]string{}
  123. if len(p.DefaultHeaders) > 0 {
  124. maps.Copy(headers, p.DefaultHeaders)
  125. }
  126. if len(config.ExtraHeaders) > 0 {
  127. maps.Copy(headers, config.ExtraHeaders)
  128. }
  129. prepared := ProviderConfig{
  130. ID: string(p.ID),
  131. Name: p.Name,
  132. BaseURL: p.APIEndpoint,
  133. APIKey: p.APIKey,
  134. Type: p.Type,
  135. Disable: config.Disable,
  136. SystemPromptPrefix: config.SystemPromptPrefix,
  137. ExtraHeaders: headers,
  138. ExtraBody: config.ExtraBody,
  139. ExtraParams: make(map[string]string),
  140. Models: p.Models,
  141. }
  142. switch p.ID {
  143. // Handle specific providers that require additional configuration
  144. case catwalk.InferenceProviderVertexAI:
  145. if !hasVertexCredentials(env) {
  146. if configExists {
  147. slog.Warn("Skipping Vertex AI provider due to missing credentials")
  148. c.Providers.Del(string(p.ID))
  149. }
  150. continue
  151. }
  152. prepared.ExtraParams["project"] = env.Get("VERTEXAI_PROJECT")
  153. prepared.ExtraParams["location"] = env.Get("VERTEXAI_LOCATION")
  154. case catwalk.InferenceProviderAzure:
  155. endpoint, err := resolver.ResolveValue(p.APIEndpoint)
  156. if err != nil || endpoint == "" {
  157. if configExists {
  158. slog.Warn("Skipping Azure provider due to missing API endpoint", "provider", p.ID, "error", err)
  159. c.Providers.Del(string(p.ID))
  160. }
  161. continue
  162. }
  163. prepared.BaseURL = endpoint
  164. prepared.ExtraParams["apiVersion"] = env.Get("AZURE_OPENAI_API_VERSION")
  165. case catwalk.InferenceProviderBedrock:
  166. if !hasAWSCredentials(env) {
  167. if configExists {
  168. slog.Warn("Skipping Bedrock provider due to missing AWS credentials")
  169. c.Providers.Del(string(p.ID))
  170. }
  171. continue
  172. }
  173. prepared.ExtraParams["region"] = env.Get("AWS_REGION")
  174. if prepared.ExtraParams["region"] == "" {
  175. prepared.ExtraParams["region"] = env.Get("AWS_DEFAULT_REGION")
  176. }
  177. for _, model := range p.Models {
  178. if !strings.HasPrefix(model.ID, "anthropic.") {
  179. return fmt.Errorf("bedrock provider only supports anthropic models for now, found: %s", model.ID)
  180. }
  181. }
  182. default:
  183. // if the provider api or endpoint are missing we skip them
  184. v, err := resolver.ResolveValue(p.APIKey)
  185. if v == "" || err != nil {
  186. if configExists {
  187. slog.Warn("Skipping provider due to missing API key", "provider", p.ID)
  188. c.Providers.Del(string(p.ID))
  189. }
  190. continue
  191. }
  192. }
  193. c.Providers.Set(string(p.ID), prepared)
  194. }
  195. // validate the custom providers
  196. for id, providerConfig := range c.Providers.Seq2() {
  197. if knownProviderNames[id] {
  198. continue
  199. }
  200. // Make sure the provider ID is set
  201. providerConfig.ID = id
  202. if providerConfig.Name == "" {
  203. providerConfig.Name = id // Use ID as name if not set
  204. }
  205. // default to OpenAI if not set
  206. if providerConfig.Type == "" {
  207. providerConfig.Type = catwalk.TypeOpenAI
  208. }
  209. if providerConfig.Disable {
  210. slog.Debug("Skipping custom provider due to disable flag", "provider", id)
  211. c.Providers.Del(id)
  212. continue
  213. }
  214. if providerConfig.APIKey == "" {
  215. slog.Warn("Provider is missing API key, this might be OK for local providers", "provider", id)
  216. }
  217. if providerConfig.BaseURL == "" {
  218. slog.Warn("Skipping custom provider due to missing API endpoint", "provider", id)
  219. c.Providers.Del(id)
  220. continue
  221. }
  222. if len(providerConfig.Models) == 0 {
  223. slog.Warn("Skipping custom provider because the provider has no models", "provider", id)
  224. c.Providers.Del(id)
  225. continue
  226. }
  227. if providerConfig.Type != catwalk.TypeOpenAI && providerConfig.Type != catwalk.TypeAnthropic {
  228. slog.Warn("Skipping custom provider because the provider type is not supported", "provider", id, "type", providerConfig.Type)
  229. c.Providers.Del(id)
  230. continue
  231. }
  232. apiKey, err := resolver.ResolveValue(providerConfig.APIKey)
  233. if apiKey == "" || err != nil {
  234. slog.Warn("Provider is missing API key, this might be OK for local providers", "provider", id)
  235. }
  236. baseURL, err := resolver.ResolveValue(providerConfig.BaseURL)
  237. if baseURL == "" || err != nil {
  238. slog.Warn("Skipping custom provider due to missing API endpoint", "provider", id, "error", err)
  239. c.Providers.Del(id)
  240. continue
  241. }
  242. c.Providers.Set(id, providerConfig)
  243. }
  244. return nil
  245. }
  246. func (c *Config) setDefaults(workingDir string) {
  247. c.workingDir = workingDir
  248. if c.Options == nil {
  249. c.Options = &Options{}
  250. }
  251. if c.Options.TUI == nil {
  252. c.Options.TUI = &TUIOptions{}
  253. }
  254. if c.Options.ContextPaths == nil {
  255. c.Options.ContextPaths = []string{}
  256. }
  257. if c.Options.DataDirectory == "" {
  258. c.Options.DataDirectory = filepath.Join(workingDir, defaultDataDirectory)
  259. }
  260. if c.Providers == nil {
  261. c.Providers = csync.NewMap[string, ProviderConfig]()
  262. }
  263. if c.Models == nil {
  264. c.Models = make(map[SelectedModelType]SelectedModel)
  265. }
  266. if c.MCP == nil {
  267. c.MCP = make(map[string]MCPConfig)
  268. }
  269. if c.LSP == nil {
  270. c.LSP = make(map[string]LSPConfig)
  271. }
  272. // Add the default context paths if they are not already present
  273. c.Options.ContextPaths = append(defaultContextPaths, c.Options.ContextPaths...)
  274. slices.Sort(c.Options.ContextPaths)
  275. c.Options.ContextPaths = slices.Compact(c.Options.ContextPaths)
  276. }
  277. func (c *Config) defaultModelSelection(knownProviders []catwalk.Provider) (largeModel SelectedModel, smallModel SelectedModel, err error) {
  278. if len(knownProviders) == 0 && c.Providers.Len() == 0 {
  279. err = fmt.Errorf("no providers configured, please configure at least one provider")
  280. return
  281. }
  282. // Use the first provider enabled based on the known providers order
  283. // if no provider found that is known use the first provider configured
  284. for _, p := range knownProviders {
  285. providerConfig, ok := c.Providers.Get(string(p.ID))
  286. if !ok || providerConfig.Disable {
  287. continue
  288. }
  289. defaultLargeModel := c.GetModel(string(p.ID), p.DefaultLargeModelID)
  290. if defaultLargeModel == nil {
  291. err = fmt.Errorf("default large model %s not found for provider %s", p.DefaultLargeModelID, p.ID)
  292. return
  293. }
  294. largeModel = SelectedModel{
  295. Provider: string(p.ID),
  296. Model: defaultLargeModel.ID,
  297. MaxTokens: defaultLargeModel.DefaultMaxTokens,
  298. ReasoningEffort: defaultLargeModel.DefaultReasoningEffort,
  299. }
  300. defaultSmallModel := c.GetModel(string(p.ID), p.DefaultSmallModelID)
  301. if defaultSmallModel == nil {
  302. err = fmt.Errorf("default small model %s not found for provider %s", p.DefaultSmallModelID, p.ID)
  303. return
  304. }
  305. smallModel = SelectedModel{
  306. Provider: string(p.ID),
  307. Model: defaultSmallModel.ID,
  308. MaxTokens: defaultSmallModel.DefaultMaxTokens,
  309. ReasoningEffort: defaultSmallModel.DefaultReasoningEffort,
  310. }
  311. return
  312. }
  313. enabledProviders := c.EnabledProviders()
  314. slices.SortFunc(enabledProviders, func(a, b ProviderConfig) int {
  315. return strings.Compare(a.ID, b.ID)
  316. })
  317. if len(enabledProviders) == 0 {
  318. err = fmt.Errorf("no providers configured, please configure at least one provider")
  319. return
  320. }
  321. providerConfig := enabledProviders[0]
  322. if len(providerConfig.Models) == 0 {
  323. err = fmt.Errorf("provider %s has no models configured", providerConfig.ID)
  324. return
  325. }
  326. defaultLargeModel := c.GetModel(providerConfig.ID, providerConfig.Models[0].ID)
  327. largeModel = SelectedModel{
  328. Provider: providerConfig.ID,
  329. Model: defaultLargeModel.ID,
  330. MaxTokens: defaultLargeModel.DefaultMaxTokens,
  331. }
  332. defaultSmallModel := c.GetModel(providerConfig.ID, providerConfig.Models[0].ID)
  333. smallModel = SelectedModel{
  334. Provider: providerConfig.ID,
  335. Model: defaultSmallModel.ID,
  336. MaxTokens: defaultSmallModel.DefaultMaxTokens,
  337. }
  338. return
  339. }
  340. func (c *Config) configureSelectedModels(knownProviders []catwalk.Provider) error {
  341. defaultLarge, defaultSmall, err := c.defaultModelSelection(knownProviders)
  342. if err != nil {
  343. return fmt.Errorf("failed to select default models: %w", err)
  344. }
  345. large, small := defaultLarge, defaultSmall
  346. largeModelSelected, largeModelConfigured := c.Models[SelectedModelTypeLarge]
  347. if largeModelConfigured {
  348. if largeModelSelected.Model != "" {
  349. large.Model = largeModelSelected.Model
  350. }
  351. if largeModelSelected.Provider != "" {
  352. large.Provider = largeModelSelected.Provider
  353. }
  354. model := c.GetModel(large.Provider, large.Model)
  355. if model == nil {
  356. large = defaultLarge
  357. // override the model type to large
  358. err := c.UpdatePreferredModel(SelectedModelTypeLarge, large)
  359. if err != nil {
  360. return fmt.Errorf("failed to update preferred large model: %w", err)
  361. }
  362. } else {
  363. if largeModelSelected.MaxTokens > 0 {
  364. large.MaxTokens = largeModelSelected.MaxTokens
  365. } else {
  366. large.MaxTokens = model.DefaultMaxTokens
  367. }
  368. if largeModelSelected.ReasoningEffort != "" {
  369. large.ReasoningEffort = largeModelSelected.ReasoningEffort
  370. }
  371. large.Think = largeModelSelected.Think
  372. }
  373. }
  374. smallModelSelected, smallModelConfigured := c.Models[SelectedModelTypeSmall]
  375. if smallModelConfigured {
  376. if smallModelSelected.Model != "" {
  377. small.Model = smallModelSelected.Model
  378. }
  379. if smallModelSelected.Provider != "" {
  380. small.Provider = smallModelSelected.Provider
  381. }
  382. model := c.GetModel(small.Provider, small.Model)
  383. if model == nil {
  384. small = defaultSmall
  385. // override the model type to small
  386. err := c.UpdatePreferredModel(SelectedModelTypeSmall, small)
  387. if err != nil {
  388. return fmt.Errorf("failed to update preferred small model: %w", err)
  389. }
  390. } else {
  391. if smallModelSelected.MaxTokens > 0 {
  392. small.MaxTokens = smallModelSelected.MaxTokens
  393. } else {
  394. small.MaxTokens = model.DefaultMaxTokens
  395. }
  396. small.ReasoningEffort = smallModelSelected.ReasoningEffort
  397. small.Think = smallModelSelected.Think
  398. }
  399. }
  400. c.Models[SelectedModelTypeLarge] = large
  401. c.Models[SelectedModelTypeSmall] = small
  402. return nil
  403. }
  404. func loadFromConfigPaths(configPaths []string) (*Config, error) {
  405. var configs []io.Reader
  406. for _, path := range configPaths {
  407. fd, err := os.Open(path)
  408. if err != nil {
  409. if os.IsNotExist(err) {
  410. continue
  411. }
  412. return nil, fmt.Errorf("failed to open config file %s: %w", path, err)
  413. }
  414. defer fd.Close()
  415. configs = append(configs, fd)
  416. }
  417. return loadFromReaders(configs)
  418. }
  419. func loadFromReaders(readers []io.Reader) (*Config, error) {
  420. if len(readers) == 0 {
  421. return &Config{}, nil
  422. }
  423. merged, err := Merge(readers)
  424. if err != nil {
  425. return nil, fmt.Errorf("failed to merge configuration readers: %w", err)
  426. }
  427. return LoadReader(merged)
  428. }
  429. func hasVertexCredentials(env env.Env) bool {
  430. hasProject := env.Get("VERTEXAI_PROJECT") != ""
  431. hasLocation := env.Get("VERTEXAI_LOCATION") != ""
  432. return hasProject && hasLocation
  433. }
  434. func hasAWSCredentials(env env.Env) bool {
  435. if env.Get("AWS_ACCESS_KEY_ID") != "" && env.Get("AWS_SECRET_ACCESS_KEY") != "" {
  436. return true
  437. }
  438. if env.Get("AWS_PROFILE") != "" || env.Get("AWS_DEFAULT_PROFILE") != "" {
  439. return true
  440. }
  441. if env.Get("AWS_REGION") != "" || env.Get("AWS_DEFAULT_REGION") != "" {
  442. return true
  443. }
  444. if env.Get("AWS_CONTAINER_CREDENTIALS_RELATIVE_URI") != "" ||
  445. env.Get("AWS_CONTAINER_CREDENTIALS_FULL_URI") != "" {
  446. return true
  447. }
  448. return false
  449. }
  450. func globalConfig() string {
  451. xdgConfigHome := os.Getenv("XDG_CONFIG_HOME")
  452. if xdgConfigHome != "" {
  453. return filepath.Join(xdgConfigHome, appName, fmt.Sprintf("%s.json", appName))
  454. }
  455. // return the path to the main config directory
  456. // for windows, it should be in `%LOCALAPPDATA%/crush/`
  457. // for linux and macOS, it should be in `$HOME/.config/crush/`
  458. if runtime.GOOS == "windows" {
  459. localAppData := os.Getenv("LOCALAPPDATA")
  460. if localAppData == "" {
  461. localAppData = filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local")
  462. }
  463. return filepath.Join(localAppData, appName, fmt.Sprintf("%s.json", appName))
  464. }
  465. return filepath.Join(os.Getenv("HOME"), ".config", appName, fmt.Sprintf("%s.json", appName))
  466. }
  467. // GlobalConfigData returns the path to the main data directory for the application.
  468. // this config is used when the app overrides configurations instead of updating the global config.
  469. func GlobalConfigData() string {
  470. xdgDataHome := os.Getenv("XDG_DATA_HOME")
  471. if xdgDataHome != "" {
  472. return filepath.Join(xdgDataHome, appName, fmt.Sprintf("%s.json", appName))
  473. }
  474. // return the path to the main data directory
  475. // for windows, it should be in `%LOCALAPPDATA%/crush/`
  476. // for linux and macOS, it should be in `$HOME/.local/share/crush/`
  477. if runtime.GOOS == "windows" {
  478. localAppData := os.Getenv("LOCALAPPDATA")
  479. if localAppData == "" {
  480. localAppData = filepath.Join(os.Getenv("USERPROFILE"), "AppData", "Local")
  481. }
  482. return filepath.Join(localAppData, appName, fmt.Sprintf("%s.json", appName))
  483. }
  484. return filepath.Join(os.Getenv("HOME"), ".local", "share", appName, fmt.Sprintf("%s.json", appName))
  485. }
  486. func HomeDir() string {
  487. homeDir := os.Getenv("HOME")
  488. if homeDir == "" {
  489. homeDir = os.Getenv("USERPROFILE") // For Windows compatibility
  490. }
  491. if homeDir == "" {
  492. homeDir = os.Getenv("HOMEPATH") // Fallback for some environments
  493. }
  494. return homeDir
  495. }