1package config
2
3import (
4 "cmp"
5 "context"
6 "fmt"
7 "log/slog"
8 "maps"
9 "net/http"
10 "net/url"
11 "os"
12 "path/filepath"
13 "slices"
14 "strings"
15 "time"
16
17 "github.com/charmbracelet/catwalk/pkg/catwalk"
18 hyperp "github.com/charmbracelet/crush/internal/agent/hyper"
19 "github.com/charmbracelet/crush/internal/csync"
20 "github.com/charmbracelet/crush/internal/env"
21 "github.com/charmbracelet/crush/internal/oauth"
22 "github.com/charmbracelet/crush/internal/oauth/copilot"
23 "github.com/charmbracelet/crush/internal/oauth/hyper"
24 "github.com/invopop/jsonschema"
25 "github.com/tidwall/gjson"
26 "github.com/tidwall/sjson"
27)
28
29const (
30 appName = "crush"
31 defaultDataDirectory = ".crush"
32 defaultInitializeAs = "AGENTS.md"
33)
34
35var defaultContextPaths = []string{
36 ".github/copilot-instructions.md",
37 ".cursorrules",
38 ".cursor/rules/",
39 "CLAUDE.md",
40 "CLAUDE.local.md",
41 "GEMINI.md",
42 "gemini.md",
43 "crush.md",
44 "crush.local.md",
45 "Crush.md",
46 "Crush.local.md",
47 "CRUSH.md",
48 "CRUSH.local.md",
49 "AGENTS.md",
50 "agents.md",
51 "Agents.md",
52}
53
54type SelectedModelType string
55
56// String returns the string representation of the [SelectedModelType].
57func (s SelectedModelType) String() string {
58 return string(s)
59}
60
61const (
62 SelectedModelTypeLarge SelectedModelType = "large"
63 SelectedModelTypeSmall SelectedModelType = "small"
64)
65
66const (
67 AgentCoder string = "coder"
68 AgentTask string = "task"
69)
70
71type SelectedModel struct {
72 // The model id as used by the provider API.
73 // Required.
74 Model string `json:"model" jsonschema:"required,description=The model ID as used by the provider API,example=gpt-4o"`
75 // The model provider, same as the key/id used in the providers config.
76 // Required.
77 Provider string `json:"provider" jsonschema:"required,description=The model provider ID that matches a key in the providers config,example=openai"`
78
79 // Only used by models that use the openai provider and need this set.
80 ReasoningEffort string `json:"reasoning_effort,omitempty" jsonschema:"description=Reasoning effort level for OpenAI models that support it,enum=low,enum=medium,enum=high"`
81
82 // Used by anthropic models that can reason to indicate if the model should think.
83 Think bool `json:"think,omitempty" jsonschema:"description=Enable thinking mode for Anthropic models that support reasoning"`
84
85 // Overrides the default model configuration.
86 MaxTokens int64 `json:"max_tokens,omitempty" jsonschema:"description=Maximum number of tokens for model responses,maximum=200000,example=4096"`
87 Temperature *float64 `json:"temperature,omitempty" jsonschema:"description=Sampling temperature,minimum=0,maximum=1,example=0.7"`
88 TopP *float64 `json:"top_p,omitempty" jsonschema:"description=Top-p (nucleus) sampling parameter,minimum=0,maximum=1,example=0.9"`
89 TopK *int64 `json:"top_k,omitempty" jsonschema:"description=Top-k sampling parameter"`
90 FrequencyPenalty *float64 `json:"frequency_penalty,omitempty" jsonschema:"description=Frequency penalty to reduce repetition"`
91 PresencePenalty *float64 `json:"presence_penalty,omitempty" jsonschema:"description=Presence penalty to increase topic diversity"`
92
93 // Override provider specific options.
94 ProviderOptions map[string]any `json:"provider_options,omitempty" jsonschema:"description=Additional provider-specific options for the model"`
95}
96
97type ProviderConfig struct {
98 // The provider's id.
99 ID string `json:"id,omitempty" jsonschema:"description=Unique identifier for the provider,example=openai"`
100 // The provider's name, used for display purposes.
101 Name string `json:"name,omitempty" jsonschema:"description=Human-readable name for the provider,example=OpenAI"`
102 // The provider's API endpoint.
103 BaseURL string `json:"base_url,omitempty" jsonschema:"description=Base URL for the provider's API,format=uri,example=https://api.openai.com/v1"`
104 // The provider type, e.g. "openai", "anthropic", etc. if empty it defaults to openai.
105 Type catwalk.Type `json:"type,omitempty" jsonschema:"description=Provider type that determines the API format,enum=openai,enum=openai-compat,enum=anthropic,enum=gemini,enum=azure,enum=vertexai,default=openai"`
106 // The provider's API key.
107 APIKey string `json:"api_key,omitempty" jsonschema:"description=API key for authentication with the provider,example=$OPENAI_API_KEY"`
108 // The original API key template before resolution (for re-resolution on auth errors).
109 APIKeyTemplate string `json:"-"`
110 // OAuthToken for providers that use OAuth2 authentication.
111 OAuthToken *oauth.Token `json:"oauth,omitempty" jsonschema:"description=OAuth2 token for authentication with the provider"`
112 // Marks the provider as disabled.
113 Disable bool `json:"disable,omitempty" jsonschema:"description=Whether this provider is disabled,default=false"`
114
115 // Custom system prompt prefix.
116 SystemPromptPrefix string `json:"system_prompt_prefix,omitempty" jsonschema:"description=Custom prefix to add to system prompts for this provider"`
117
118 // Extra headers to send with each request to the provider.
119 ExtraHeaders map[string]string `json:"extra_headers,omitempty" jsonschema:"description=Additional HTTP headers to send with requests"`
120 // Extra body
121 ExtraBody map[string]any `json:"extra_body,omitempty" jsonschema:"description=Additional fields to include in request bodies, only works with openai-compatible providers"`
122
123 ProviderOptions map[string]any `json:"provider_options,omitempty" jsonschema:"description=Additional provider-specific options for this provider"`
124
125 // Used to pass extra parameters to the provider.
126 ExtraParams map[string]string `json:"-"`
127
128 // The provider models
129 Models []catwalk.Model `json:"models,omitempty" jsonschema:"description=List of models available from this provider"`
130}
131
132// ToProvider converts the [ProviderConfig] to a [catwalk.Provider].
133func (pc *ProviderConfig) ToProvider() catwalk.Provider {
134 // Convert config provider to provider.Provider format
135 provider := catwalk.Provider{
136 Name: pc.Name,
137 ID: catwalk.InferenceProvider(pc.ID),
138 Models: make([]catwalk.Model, len(pc.Models)),
139 }
140
141 // Convert models
142 for i, model := range pc.Models {
143 provider.Models[i] = catwalk.Model{
144 ID: model.ID,
145 Name: model.Name,
146 CostPer1MIn: model.CostPer1MIn,
147 CostPer1MOut: model.CostPer1MOut,
148 CostPer1MInCached: model.CostPer1MInCached,
149 CostPer1MOutCached: model.CostPer1MOutCached,
150 ContextWindow: model.ContextWindow,
151 DefaultMaxTokens: model.DefaultMaxTokens,
152 CanReason: model.CanReason,
153 ReasoningLevels: model.ReasoningLevels,
154 DefaultReasoningEffort: model.DefaultReasoningEffort,
155 SupportsImages: model.SupportsImages,
156 }
157 }
158
159 return provider
160}
161
162func (pc *ProviderConfig) SetupGitHubCopilot() {
163 maps.Copy(pc.ExtraHeaders, copilot.Headers())
164}
165
166type MCPType string
167
168const (
169 MCPStdio MCPType = "stdio"
170 MCPSSE MCPType = "sse"
171 MCPHttp MCPType = "http"
172)
173
174type MCPConfig struct {
175 Command string `json:"command,omitempty" jsonschema:"description=Command to execute for stdio MCP servers,example=npx"`
176 Env map[string]string `json:"env,omitempty" jsonschema:"description=Environment variables to set for the MCP server"`
177 Args []string `json:"args,omitempty" jsonschema:"description=Arguments to pass to the MCP server command"`
178 Type MCPType `json:"type" jsonschema:"required,description=Type of MCP connection,enum=stdio,enum=sse,enum=http,default=stdio"`
179 URL string `json:"url,omitempty" jsonschema:"description=URL for HTTP or SSE MCP servers,format=uri,example=http://localhost:3000/mcp"`
180 Disabled bool `json:"disabled,omitempty" jsonschema:"description=Whether this MCP server is disabled,default=false"`
181 DisabledTools []string `json:"disabled_tools,omitempty" jsonschema:"description=List of tools from this MCP server to disable,example=get-library-doc"`
182 Timeout int `json:"timeout,omitempty" jsonschema:"description=Timeout in seconds for MCP server connections,default=15,example=30,example=60,example=120"`
183
184 // TODO: maybe make it possible to get the value from the env
185 Headers map[string]string `json:"headers,omitempty" jsonschema:"description=HTTP headers for HTTP/SSE MCP servers"`
186}
187
188type LSPConfig struct {
189 Disabled bool `json:"disabled,omitempty" jsonschema:"description=Whether this LSP server is disabled,default=false"`
190 Command string `json:"command,omitempty" jsonschema:"required,description=Command to execute for the LSP server,example=gopls"`
191 Args []string `json:"args,omitempty" jsonschema:"description=Arguments to pass to the LSP server command"`
192 Env map[string]string `json:"env,omitempty" jsonschema:"description=Environment variables to set to the LSP server command"`
193 FileTypes []string `json:"filetypes,omitempty" jsonschema:"description=File types this LSP server handles,example=go,example=mod,example=rs,example=c,example=js,example=ts"`
194 RootMarkers []string `json:"root_markers,omitempty" jsonschema:"description=Files or directories that indicate the project root,example=go.mod,example=package.json,example=Cargo.toml"`
195 InitOptions map[string]any `json:"init_options,omitempty" jsonschema:"description=Initialization options passed to the LSP server during initialize request"`
196 Options map[string]any `json:"options,omitempty" jsonschema:"description=LSP server-specific settings passed during initialization"`
197}
198
199type TUIOptions struct {
200 CompactMode bool `json:"compact_mode,omitempty" jsonschema:"description=Enable compact mode for the TUI interface,default=false"`
201 DiffMode string `json:"diff_mode,omitempty" jsonschema:"description=Diff mode for the TUI interface,enum=unified,enum=split"`
202 // Here we can add themes later or any TUI related options
203 //
204
205 Completions Completions `json:"completions,omitzero" jsonschema:"description=Completions UI options"`
206}
207
208// Completions defines options for the completions UI.
209type Completions struct {
210 MaxDepth *int `json:"max_depth,omitempty" jsonschema:"description=Maximum depth for the ls tool,default=0,example=10"`
211 MaxItems *int `json:"max_items,omitempty" jsonschema:"description=Maximum number of items to return for the ls tool,default=1000,example=100"`
212}
213
214func (c Completions) Limits() (depth, items int) {
215 return ptrValOr(c.MaxDepth, 0), ptrValOr(c.MaxItems, 0)
216}
217
218type Permissions struct {
219 AllowedTools []string `json:"allowed_tools,omitempty" jsonschema:"description=List of tools that don't require permission prompts,example=bash,example=view"` // Tools that don't require permission prompts
220 SkipRequests bool `json:"-"` // Automatically accept all permissions (YOLO mode)
221}
222
223type TrailerStyle string
224
225const (
226 TrailerStyleNone TrailerStyle = "none"
227 TrailerStyleCoAuthoredBy TrailerStyle = "co-authored-by"
228 TrailerStyleAssistedBy TrailerStyle = "assisted-by"
229)
230
231type Attribution struct {
232 TrailerStyle TrailerStyle `json:"trailer_style,omitempty" jsonschema:"description=Style of attribution trailer to add to commits,enum=none,enum=co-authored-by,enum=assisted-by,default=assisted-by"`
233 CoAuthoredBy *bool `json:"co_authored_by,omitempty" jsonschema:"description=Deprecated: use trailer_style instead"`
234 GeneratedWith bool `json:"generated_with,omitempty" jsonschema:"description=Add Generated with Crush line to commit messages and issues and PRs,default=true"`
235}
236
237// JSONSchemaExtend marks the co_authored_by field as deprecated in the schema.
238func (Attribution) JSONSchemaExtend(schema *jsonschema.Schema) {
239 if schema.Properties != nil {
240 if prop, ok := schema.Properties.Get("co_authored_by"); ok {
241 prop.Deprecated = true
242 }
243 }
244}
245
246type Options struct {
247 ContextPaths []string `json:"context_paths,omitempty" jsonschema:"description=Paths to files containing context information for the AI,example=.cursorrules,example=CRUSH.md"`
248 SkillsPaths []string `json:"skills_paths,omitempty" jsonschema:"description=Paths to directories containing Agent Skills (folders with SKILL.md files),example=~/.config/crush/skills,example=./skills"`
249 TUI *TUIOptions `json:"tui,omitempty" jsonschema:"description=Terminal user interface options"`
250 Debug bool `json:"debug,omitempty" jsonschema:"description=Enable debug logging,default=false"`
251 DebugLSP bool `json:"debug_lsp,omitempty" jsonschema:"description=Enable debug logging for LSP servers,default=false"`
252 DisableAutoSummarize bool `json:"disable_auto_summarize,omitempty" jsonschema:"description=Disable automatic conversation summarization,default=false"`
253 DataDirectory string `json:"data_directory,omitempty" jsonschema:"description=Directory for storing application data (relative to working directory),default=.crush,example=.crush"` // Relative to the cwd
254 DisabledTools []string `json:"disabled_tools,omitempty" jsonschema:"description=List of built-in tools to disable and hide from the agent,example=bash,example=sourcegraph"`
255 DisableProviderAutoUpdate bool `json:"disable_provider_auto_update,omitempty" jsonschema:"description=Disable providers auto-update,default=false"`
256 DisableDefaultProviders bool `json:"disable_default_providers,omitempty" jsonschema:"description=Ignore all default/embedded providers. When enabled, providers must be fully specified in the config file with base_url, models, and api_key - no merging with defaults occurs,default=false"`
257 Attribution *Attribution `json:"attribution,omitempty" jsonschema:"description=Attribution settings for generated content"`
258 DisableMetrics bool `json:"disable_metrics,omitempty" jsonschema:"description=Disable sending metrics,default=false"`
259 InitializeAs string `json:"initialize_as,omitempty" jsonschema:"description=Name of the context file to create/update during project initialization,default=AGENTS.md,example=AGENTS.md,example=CRUSH.md,example=CLAUDE.md,example=docs/LLMs.md"`
260}
261
262type MCPs map[string]MCPConfig
263
264type MCP struct {
265 Name string `json:"name"`
266 MCP MCPConfig `json:"mcp"`
267}
268
269func (m MCPs) Sorted() []MCP {
270 sorted := make([]MCP, 0, len(m))
271 for k, v := range m {
272 sorted = append(sorted, MCP{
273 Name: k,
274 MCP: v,
275 })
276 }
277 slices.SortFunc(sorted, func(a, b MCP) int {
278 return strings.Compare(a.Name, b.Name)
279 })
280 return sorted
281}
282
283type LSPs map[string]LSPConfig
284
285type LSP struct {
286 Name string `json:"name"`
287 LSP LSPConfig `json:"lsp"`
288}
289
290func (l LSPs) Sorted() []LSP {
291 sorted := make([]LSP, 0, len(l))
292 for k, v := range l {
293 sorted = append(sorted, LSP{
294 Name: k,
295 LSP: v,
296 })
297 }
298 slices.SortFunc(sorted, func(a, b LSP) int {
299 return strings.Compare(a.Name, b.Name)
300 })
301 return sorted
302}
303
304func (l LSPConfig) ResolvedEnv() []string {
305 return resolveEnvs(l.Env)
306}
307
308func (m MCPConfig) ResolvedEnv() []string {
309 return resolveEnvs(m.Env)
310}
311
312func (m MCPConfig) ResolvedHeaders() map[string]string {
313 resolver := NewShellVariableResolver(env.New())
314 for e, v := range m.Headers {
315 var err error
316 m.Headers[e], err = resolver.ResolveValue(v)
317 if err != nil {
318 slog.Error("error resolving header variable", "error", err, "variable", e, "value", v)
319 continue
320 }
321 }
322 return m.Headers
323}
324
325type Agent struct {
326 ID string `json:"id,omitempty"`
327 Name string `json:"name,omitempty"`
328 Description string `json:"description,omitempty"`
329 // This is the id of the system prompt used by the agent
330 Disabled bool `json:"disabled,omitempty"`
331
332 Model SelectedModelType `json:"model" jsonschema:"required,description=The model type to use for this agent,enum=large,enum=small,default=large"`
333
334 // The available tools for the agent
335 // if this is nil, all tools are available
336 AllowedTools []string `json:"allowed_tools,omitempty"`
337
338 // this tells us which MCPs are available for this agent
339 // if this is empty all mcps are available
340 // the string array is the list of tools from the AllowedMCP the agent has available
341 // if the string array is nil, all tools from the AllowedMCP are available
342 AllowedMCP map[string][]string `json:"allowed_mcp,omitempty"`
343
344 // Overrides the context paths for this agent
345 ContextPaths []string `json:"context_paths,omitempty"`
346}
347
348type Tools struct {
349 Ls ToolLs `json:"ls,omitzero"`
350}
351
352type ToolLs struct {
353 MaxDepth *int `json:"max_depth,omitempty" jsonschema:"description=Maximum depth for the ls tool,default=0,example=10"`
354 MaxItems *int `json:"max_items,omitempty" jsonschema:"description=Maximum number of items to return for the ls tool,default=1000,example=100"`
355}
356
357func (t ToolLs) Limits() (depth, items int) {
358 return ptrValOr(t.MaxDepth, 0), ptrValOr(t.MaxItems, 0)
359}
360
361// Config holds the configuration for crush.
362type Config struct {
363 Schema string `json:"$schema,omitempty"`
364
365 // We currently only support large/small as values here.
366 Models map[SelectedModelType]SelectedModel `json:"models,omitempty" jsonschema:"description=Model configurations for different model types,example={\"large\":{\"model\":\"gpt-4o\",\"provider\":\"openai\"}}"`
367 // Recently used models stored in the data directory config.
368 RecentModels map[SelectedModelType][]SelectedModel `json:"recent_models,omitempty" jsonschema:"description=Recently used models sorted by most recent first"`
369
370 // The providers that are configured
371 Providers *csync.Map[string, ProviderConfig] `json:"providers,omitempty" jsonschema:"description=AI provider configurations"`
372
373 MCP MCPs `json:"mcp,omitempty" jsonschema:"description=Model Context Protocol server configurations"`
374
375 LSP LSPs `json:"lsp,omitempty" jsonschema:"description=Language Server Protocol configurations"`
376
377 Options *Options `json:"options,omitempty" jsonschema:"description=General application options"`
378
379 Permissions *Permissions `json:"permissions,omitempty" jsonschema:"description=Permission settings for tool usage"`
380
381 Tools Tools `json:"tools,omitzero" jsonschema:"description=Tool configurations"`
382
383 Agents map[string]Agent `json:"-"`
384
385 // Internal
386 workingDir string `json:"-"`
387 // TODO: find a better way to do this this should probably not be part of the config
388 resolver VariableResolver
389 dataConfigDir string `json:"-"`
390 knownProviders []catwalk.Provider `json:"-"`
391}
392
393func (c *Config) WorkingDir() string {
394 return c.workingDir
395}
396
397func (c *Config) EnabledProviders() []ProviderConfig {
398 var enabled []ProviderConfig
399 for p := range c.Providers.Seq() {
400 if !p.Disable {
401 enabled = append(enabled, p)
402 }
403 }
404 return enabled
405}
406
407// IsConfigured return true if at least one provider is configured
408func (c *Config) IsConfigured() bool {
409 return len(c.EnabledProviders()) > 0
410}
411
412func (c *Config) GetModel(provider, model string) *catwalk.Model {
413 if providerConfig, ok := c.Providers.Get(provider); ok {
414 for _, m := range providerConfig.Models {
415 if m.ID == model {
416 return &m
417 }
418 }
419 }
420 return nil
421}
422
423func (c *Config) GetProviderForModel(modelType SelectedModelType) *ProviderConfig {
424 model, ok := c.Models[modelType]
425 if !ok {
426 return nil
427 }
428 if providerConfig, ok := c.Providers.Get(model.Provider); ok {
429 return &providerConfig
430 }
431 return nil
432}
433
434func (c *Config) GetModelByType(modelType SelectedModelType) *catwalk.Model {
435 model, ok := c.Models[modelType]
436 if !ok {
437 return nil
438 }
439 return c.GetModel(model.Provider, model.Model)
440}
441
442func (c *Config) LargeModel() *catwalk.Model {
443 model, ok := c.Models[SelectedModelTypeLarge]
444 if !ok {
445 return nil
446 }
447 return c.GetModel(model.Provider, model.Model)
448}
449
450func (c *Config) SmallModel() *catwalk.Model {
451 model, ok := c.Models[SelectedModelTypeSmall]
452 if !ok {
453 return nil
454 }
455 return c.GetModel(model.Provider, model.Model)
456}
457
458func (c *Config) SetCompactMode(enabled bool) error {
459 if c.Options == nil {
460 c.Options = &Options{}
461 }
462 c.Options.TUI.CompactMode = enabled
463 return c.SetConfigField("options.tui.compact_mode", enabled)
464}
465
466func (c *Config) Resolve(key string) (string, error) {
467 if c.resolver == nil {
468 return "", fmt.Errorf("no variable resolver configured")
469 }
470 return c.resolver.ResolveValue(key)
471}
472
473func (c *Config) UpdatePreferredModel(modelType SelectedModelType, model SelectedModel) error {
474 c.Models[modelType] = model
475 if err := c.SetConfigField(fmt.Sprintf("models.%s", modelType), model); err != nil {
476 return fmt.Errorf("failed to update preferred model: %w", err)
477 }
478 if err := c.recordRecentModel(modelType, model); err != nil {
479 return err
480 }
481 return nil
482}
483
484func (c *Config) HasConfigField(key string) bool {
485 data, err := os.ReadFile(c.dataConfigDir)
486 if err != nil {
487 return false
488 }
489 return gjson.Get(string(data), key).Exists()
490}
491
492func (c *Config) SetConfigField(key string, value any) error {
493 data, err := os.ReadFile(c.dataConfigDir)
494 if err != nil {
495 if os.IsNotExist(err) {
496 data = []byte("{}")
497 } else {
498 return fmt.Errorf("failed to read config file: %w", err)
499 }
500 }
501
502 newValue, err := sjson.Set(string(data), key, value)
503 if err != nil {
504 return fmt.Errorf("failed to set config field %s: %w", key, err)
505 }
506 if err := os.MkdirAll(filepath.Dir(c.dataConfigDir), 0o755); err != nil {
507 return fmt.Errorf("failed to create config directory %q: %w", c.dataConfigDir, err)
508 }
509 if err := os.WriteFile(c.dataConfigDir, []byte(newValue), 0o600); err != nil {
510 return fmt.Errorf("failed to write config file: %w", err)
511 }
512 return nil
513}
514
515func (c *Config) RemoveConfigField(key string) error {
516 data, err := os.ReadFile(c.dataConfigDir)
517 if err != nil {
518 return fmt.Errorf("failed to read config file: %w", err)
519 }
520
521 newValue, err := sjson.Delete(string(data), key)
522 if err != nil {
523 return fmt.Errorf("failed to delete config field %s: %w", key, err)
524 }
525 if err := os.MkdirAll(filepath.Dir(c.dataConfigDir), 0o755); err != nil {
526 return fmt.Errorf("failed to create config directory %q: %w", c.dataConfigDir, err)
527 }
528 if err := os.WriteFile(c.dataConfigDir, []byte(newValue), 0o600); err != nil {
529 return fmt.Errorf("failed to write config file: %w", err)
530 }
531 return nil
532}
533
534// RefreshOAuthToken refreshes the OAuth token for the given provider.
535func (c *Config) RefreshOAuthToken(ctx context.Context, providerID string) error {
536 providerConfig, exists := c.Providers.Get(providerID)
537 if !exists {
538 return fmt.Errorf("provider %s not found", providerID)
539 }
540
541 if providerConfig.OAuthToken == nil {
542 return fmt.Errorf("provider %s does not have an OAuth token", providerID)
543 }
544
545 var newToken *oauth.Token
546 var refreshErr error
547 switch providerID {
548 case string(catwalk.InferenceProviderCopilot):
549 newToken, refreshErr = copilot.RefreshToken(ctx, providerConfig.OAuthToken.RefreshToken)
550 case hyperp.Name:
551 newToken, refreshErr = hyper.ExchangeToken(ctx, providerConfig.OAuthToken.RefreshToken)
552 default:
553 return fmt.Errorf("OAuth refresh not supported for provider %s", providerID)
554 }
555 if refreshErr != nil {
556 return fmt.Errorf("failed to refresh OAuth token for provider %s: %w", providerID, refreshErr)
557 }
558
559 slog.Info("Successfully refreshed OAuth token", "provider", providerID)
560 providerConfig.OAuthToken = newToken
561 providerConfig.APIKey = newToken.AccessToken
562
563 switch providerID {
564 case string(catwalk.InferenceProviderCopilot):
565 providerConfig.SetupGitHubCopilot()
566 }
567
568 c.Providers.Set(providerID, providerConfig)
569
570 if err := cmp.Or(
571 c.SetConfigField(fmt.Sprintf("providers.%s.api_key", providerID), newToken.AccessToken),
572 c.SetConfigField(fmt.Sprintf("providers.%s.oauth", providerID), newToken),
573 ); err != nil {
574 return fmt.Errorf("failed to persist refreshed token: %w", err)
575 }
576
577 return nil
578}
579
580func (c *Config) SetProviderAPIKey(providerID string, apiKey any) error {
581 var providerConfig ProviderConfig
582 var exists bool
583 var setKeyOrToken func()
584
585 switch v := apiKey.(type) {
586 case string:
587 if err := c.SetConfigField(fmt.Sprintf("providers.%s.api_key", providerID), v); err != nil {
588 return fmt.Errorf("failed to save api key to config file: %w", err)
589 }
590 setKeyOrToken = func() { providerConfig.APIKey = v }
591 case *oauth.Token:
592 if err := cmp.Or(
593 c.SetConfigField(fmt.Sprintf("providers.%s.api_key", providerID), v.AccessToken),
594 c.SetConfigField(fmt.Sprintf("providers.%s.oauth", providerID), v),
595 ); err != nil {
596 return err
597 }
598 setKeyOrToken = func() {
599 providerConfig.APIKey = v.AccessToken
600 providerConfig.OAuthToken = v
601 switch providerID {
602 case string(catwalk.InferenceProviderCopilot):
603 providerConfig.SetupGitHubCopilot()
604 }
605 }
606 }
607
608 providerConfig, exists = c.Providers.Get(providerID)
609 if exists {
610 setKeyOrToken()
611 c.Providers.Set(providerID, providerConfig)
612 return nil
613 }
614
615 var foundProvider *catwalk.Provider
616 for _, p := range c.knownProviders {
617 if string(p.ID) == providerID {
618 foundProvider = &p
619 break
620 }
621 }
622
623 if foundProvider != nil {
624 // Create new provider config based on known provider
625 providerConfig = ProviderConfig{
626 ID: providerID,
627 Name: foundProvider.Name,
628 BaseURL: foundProvider.APIEndpoint,
629 Type: foundProvider.Type,
630 Disable: false,
631 ExtraHeaders: make(map[string]string),
632 ExtraParams: make(map[string]string),
633 Models: foundProvider.Models,
634 }
635 setKeyOrToken()
636 } else {
637 return fmt.Errorf("provider with ID %s not found in known providers", providerID)
638 }
639 // Store the updated provider config
640 c.Providers.Set(providerID, providerConfig)
641 return nil
642}
643
644const maxRecentModelsPerType = 5
645
646func (c *Config) recordRecentModel(modelType SelectedModelType, model SelectedModel) error {
647 if model.Provider == "" || model.Model == "" {
648 return nil
649 }
650
651 if c.RecentModels == nil {
652 c.RecentModels = make(map[SelectedModelType][]SelectedModel)
653 }
654
655 eq := func(a, b SelectedModel) bool {
656 return a.Provider == b.Provider && a.Model == b.Model
657 }
658
659 entry := SelectedModel{
660 Provider: model.Provider,
661 Model: model.Model,
662 }
663
664 current := c.RecentModels[modelType]
665 withoutCurrent := slices.DeleteFunc(slices.Clone(current), func(existing SelectedModel) bool {
666 return eq(existing, entry)
667 })
668
669 updated := append([]SelectedModel{entry}, withoutCurrent...)
670 if len(updated) > maxRecentModelsPerType {
671 updated = updated[:maxRecentModelsPerType]
672 }
673
674 if slices.EqualFunc(current, updated, eq) {
675 return nil
676 }
677
678 c.RecentModels[modelType] = updated
679
680 if err := c.SetConfigField(fmt.Sprintf("recent_models.%s", modelType), updated); err != nil {
681 return fmt.Errorf("failed to persist recent models: %w", err)
682 }
683
684 return nil
685}
686
687func allToolNames() []string {
688 return []string{
689 "agent",
690 "bash",
691 "job_output",
692 "job_kill",
693 "download",
694 "edit",
695 "multiedit",
696 "lsp_diagnostics",
697 "lsp_references",
698 "fetch",
699 "agentic_fetch",
700 "glob",
701 "grep",
702 "ls",
703 "sourcegraph",
704 "todos",
705 "view",
706 "write",
707 }
708}
709
710func resolveAllowedTools(allTools []string, disabledTools []string) []string {
711 if disabledTools == nil {
712 return allTools
713 }
714 // filter out disabled tools (exclude mode)
715 return filterSlice(allTools, disabledTools, false)
716}
717
718func resolveReadOnlyTools(tools []string) []string {
719 readOnlyTools := []string{"glob", "grep", "ls", "sourcegraph", "view"}
720 // filter to only include tools that are in allowedtools (include mode)
721 return filterSlice(tools, readOnlyTools, true)
722}
723
724func filterSlice(data []string, mask []string, include bool) []string {
725 filtered := []string{}
726 for _, s := range data {
727 // if include is true, we include items that ARE in the mask
728 // if include is false, we include items that are NOT in the mask
729 if include == slices.Contains(mask, s) {
730 filtered = append(filtered, s)
731 }
732 }
733 return filtered
734}
735
736func (c *Config) SetupAgents() {
737 allowedTools := resolveAllowedTools(allToolNames(), c.Options.DisabledTools)
738
739 agents := map[string]Agent{
740 AgentCoder: {
741 ID: AgentCoder,
742 Name: "Coder",
743 Description: "An agent that helps with executing coding tasks.",
744 Model: SelectedModelTypeLarge,
745 ContextPaths: c.Options.ContextPaths,
746 AllowedTools: allowedTools,
747 },
748
749 AgentTask: {
750 ID: AgentCoder,
751 Name: "Task",
752 Description: "An agent that helps with searching for context and finding implementation details.",
753 Model: SelectedModelTypeLarge,
754 ContextPaths: c.Options.ContextPaths,
755 AllowedTools: resolveReadOnlyTools(allowedTools),
756 // NO MCPs or LSPs by default
757 AllowedMCP: map[string][]string{},
758 },
759 }
760 c.Agents = agents
761}
762
763func (c *Config) Resolver() VariableResolver {
764 return c.resolver
765}
766
767func (c *ProviderConfig) TestConnection(resolver VariableResolver) error {
768 testURL := ""
769 headers := make(map[string]string)
770 apiKey, _ := resolver.ResolveValue(c.APIKey)
771 switch c.Type {
772 case catwalk.TypeOpenAI, catwalk.TypeOpenAICompat, catwalk.TypeOpenRouter:
773 baseURL, _ := resolver.ResolveValue(c.BaseURL)
774 if baseURL == "" {
775 baseURL = "https://api.openai.com/v1"
776 }
777 if c.ID == string(catwalk.InferenceProviderOpenRouter) {
778 testURL = baseURL + "/credits"
779 } else {
780 testURL = baseURL + "/models"
781 }
782 headers["Authorization"] = "Bearer " + apiKey
783 case catwalk.TypeAnthropic:
784 baseURL, _ := resolver.ResolveValue(c.BaseURL)
785 if baseURL == "" {
786 baseURL = "https://api.anthropic.com/v1"
787 }
788 testURL = baseURL + "/models"
789 // TODO: replace with const when catwalk is released
790 if c.ID == "kimi-coding" {
791 testURL = baseURL + "/v1/models"
792 }
793 headers["x-api-key"] = apiKey
794 headers["anthropic-version"] = "2023-06-01"
795 case catwalk.TypeGoogle:
796 baseURL, _ := resolver.ResolveValue(c.BaseURL)
797 if baseURL == "" {
798 baseURL = "https://generativelanguage.googleapis.com"
799 }
800 testURL = baseURL + "/v1beta/models?key=" + url.QueryEscape(apiKey)
801 }
802 ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
803 defer cancel()
804 client := &http.Client{}
805 req, err := http.NewRequestWithContext(ctx, "GET", testURL, nil)
806 if err != nil {
807 return fmt.Errorf("failed to create request for provider %s: %w", c.ID, err)
808 }
809 for k, v := range headers {
810 req.Header.Set(k, v)
811 }
812 for k, v := range c.ExtraHeaders {
813 req.Header.Set(k, v)
814 }
815 resp, err := client.Do(req)
816 if err != nil {
817 return fmt.Errorf("failed to create request for provider %s: %w", c.ID, err)
818 }
819 defer resp.Body.Close()
820 if c.ID == string(catwalk.InferenceProviderZAI) {
821 if resp.StatusCode == http.StatusUnauthorized {
822 // For z.ai just check if the http response is not 401.
823 return fmt.Errorf("failed to connect to provider %s: %s", c.ID, resp.Status)
824 }
825 } else {
826 if resp.StatusCode != http.StatusOK {
827 return fmt.Errorf("failed to connect to provider %s: %s", c.ID, resp.Status)
828 }
829 }
830 return nil
831}
832
833func resolveEnvs(envs map[string]string) []string {
834 resolver := NewShellVariableResolver(env.New())
835 for e, v := range envs {
836 var err error
837 envs[e], err = resolver.ResolveValue(v)
838 if err != nil {
839 slog.Error("error resolving environment variable", "error", err, "variable", e, "value", v)
840 continue
841 }
842 }
843
844 res := make([]string, 0, len(envs))
845 for k, v := range envs {
846 res = append(res, fmt.Sprintf("%s=%s", k, v))
847 }
848 return res
849}
850
851func ptrValOr[T any](t *T, el T) T {
852 if t == nil {
853 return el
854 }
855 return *t
856}