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 "charm.land/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:"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 Timeout int `json:"timeout,omitempty" jsonschema:"description=Timeout in seconds for LSP server initialization,default=30,example=60,example=120"`
198}
199
200type TUIOptions struct {
201 CompactMode bool `json:"compact_mode,omitempty" jsonschema:"description=Enable compact mode for the TUI interface,default=false"`
202 DiffMode string `json:"diff_mode,omitempty" jsonschema:"description=Diff mode for the TUI interface,enum=unified,enum=split"`
203 // Here we can add themes later or any TUI related options
204 //
205
206 Completions Completions `json:"completions,omitzero" jsonschema:"description=Completions UI options"`
207 Transparent *bool `json:"transparent,omitempty" jsonschema:"description=Enable transparent background for the TUI interface,default=false"`
208}
209
210// Completions defines options for the completions UI.
211type Completions struct {
212 MaxDepth *int `json:"max_depth,omitempty" jsonschema:"description=Maximum depth for the ls tool,default=0,example=10"`
213 MaxItems *int `json:"max_items,omitempty" jsonschema:"description=Maximum number of items to return for the ls tool,default=1000,example=100"`
214}
215
216func (c Completions) Limits() (depth, items int) {
217 return ptrValOr(c.MaxDepth, 0), ptrValOr(c.MaxItems, 0)
218}
219
220type Permissions struct {
221 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
222 SkipRequests bool `json:"-"` // Automatically accept all permissions (YOLO mode)
223}
224
225type TrailerStyle string
226
227const (
228 TrailerStyleNone TrailerStyle = "none"
229 TrailerStyleCoAuthoredBy TrailerStyle = "co-authored-by"
230 TrailerStyleAssistedBy TrailerStyle = "assisted-by"
231)
232
233type Attribution struct {
234 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"`
235 CoAuthoredBy *bool `json:"co_authored_by,omitempty" jsonschema:"description=Deprecated: use trailer_style instead"`
236 GeneratedWith bool `json:"generated_with,omitempty" jsonschema:"description=Add Generated with Crush line to commit messages and issues and PRs,default=true"`
237}
238
239// JSONSchemaExtend marks the co_authored_by field as deprecated in the schema.
240func (Attribution) JSONSchemaExtend(schema *jsonschema.Schema) {
241 if schema.Properties != nil {
242 if prop, ok := schema.Properties.Get("co_authored_by"); ok {
243 prop.Deprecated = true
244 }
245 }
246}
247
248type Options struct {
249 ContextPaths []string `json:"context_paths,omitempty" jsonschema:"description=Paths to files containing context information for the AI,example=.cursorrules,example=CRUSH.md"`
250 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"`
251 TUI *TUIOptions `json:"tui,omitempty" jsonschema:"description=Terminal user interface options"`
252 Debug bool `json:"debug,omitempty" jsonschema:"description=Enable debug logging,default=false"`
253 DebugLSP bool `json:"debug_lsp,omitempty" jsonschema:"description=Enable debug logging for LSP servers,default=false"`
254 DisableAutoSummarize bool `json:"disable_auto_summarize,omitempty" jsonschema:"description=Disable automatic conversation summarization,default=false"`
255 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
256 DisabledTools []string `json:"disabled_tools,omitempty" jsonschema:"description=List of built-in tools to disable and hide from the agent,example=bash,example=sourcegraph"`
257 DisableProviderAutoUpdate bool `json:"disable_provider_auto_update,omitempty" jsonschema:"description=Disable providers auto-update,default=false"`
258 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"`
259 Attribution *Attribution `json:"attribution,omitempty" jsonschema:"description=Attribution settings for generated content"`
260 DisableMetrics bool `json:"disable_metrics,omitempty" jsonschema:"description=Disable sending metrics,default=false"`
261 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"`
262 AutoLSP *bool `json:"auto_lsp,omitempty" jsonschema:"description=Automatically setup LSPs based on root markers,default=true"`
263 Progress *bool `json:"progress,omitempty" jsonschema:"description=Show indeterminate progress updates during long operations,default=true"`
264}
265
266type MCPs map[string]MCPConfig
267
268type MCP struct {
269 Name string `json:"name"`
270 MCP MCPConfig `json:"mcp"`
271}
272
273func (m MCPs) Sorted() []MCP {
274 sorted := make([]MCP, 0, len(m))
275 for k, v := range m {
276 sorted = append(sorted, MCP{
277 Name: k,
278 MCP: v,
279 })
280 }
281 slices.SortFunc(sorted, func(a, b MCP) int {
282 return strings.Compare(a.Name, b.Name)
283 })
284 return sorted
285}
286
287type LSPs map[string]LSPConfig
288
289type LSP struct {
290 Name string `json:"name"`
291 LSP LSPConfig `json:"lsp"`
292}
293
294func (l LSPs) Sorted() []LSP {
295 sorted := make([]LSP, 0, len(l))
296 for k, v := range l {
297 sorted = append(sorted, LSP{
298 Name: k,
299 LSP: v,
300 })
301 }
302 slices.SortFunc(sorted, func(a, b LSP) int {
303 return strings.Compare(a.Name, b.Name)
304 })
305 return sorted
306}
307
308func (l LSPConfig) ResolvedEnv() []string {
309 return resolveEnvs(l.Env)
310}
311
312func (m MCPConfig) ResolvedEnv() []string {
313 return resolveEnvs(m.Env)
314}
315
316func (m MCPConfig) ResolvedHeaders() map[string]string {
317 resolver := NewShellVariableResolver(env.New())
318 for e, v := range m.Headers {
319 var err error
320 m.Headers[e], err = resolver.ResolveValue(v)
321 if err != nil {
322 slog.Error("Error resolving header variable", "error", err, "variable", e, "value", v)
323 continue
324 }
325 }
326 return m.Headers
327}
328
329type Agent struct {
330 ID string `json:"id,omitempty"`
331 Name string `json:"name,omitempty"`
332 Description string `json:"description,omitempty"`
333 // This is the id of the system prompt used by the agent
334 Disabled bool `json:"disabled,omitempty"`
335
336 Model SelectedModelType `json:"model" jsonschema:"required,description=The model type to use for this agent,enum=large,enum=small,default=large"`
337
338 // The available tools for the agent
339 // if this is nil, all tools are available
340 AllowedTools []string `json:"allowed_tools,omitempty"`
341
342 // this tells us which MCPs are available for this agent
343 // if this is empty all mcps are available
344 // the string array is the list of tools from the AllowedMCP the agent has available
345 // if the string array is nil, all tools from the AllowedMCP are available
346 AllowedMCP map[string][]string `json:"allowed_mcp,omitempty"`
347
348 // Overrides the context paths for this agent
349 ContextPaths []string `json:"context_paths,omitempty"`
350}
351
352type Tools struct {
353 Ls ToolLs `json:"ls,omitzero"`
354 Grep ToolGrep `json:"grep,omitzero"`
355}
356
357type ToolLs struct {
358 MaxDepth *int `json:"max_depth,omitempty" jsonschema:"description=Maximum depth for the ls tool,default=0,example=10"`
359 MaxItems *int `json:"max_items,omitempty" jsonschema:"description=Maximum number of items to return for the ls tool,default=1000,example=100"`
360}
361
362// Limits returns the user-defined max-depth and max-items, or their defaults.
363func (t ToolLs) Limits() (depth, items int) {
364 return ptrValOr(t.MaxDepth, 0), ptrValOr(t.MaxItems, 0)
365}
366
367type ToolGrep struct {
368 Timeout *time.Duration `json:"timeout,omitempty" jsonschema:"description=Timeout for the grep tool call,default=5s,example=10s"`
369}
370
371// GetTimeout returns the user-defined timeout or the default.
372func (t ToolGrep) GetTimeout() time.Duration {
373 return ptrValOr(t.Timeout, 5*time.Second)
374}
375
376// Config holds the configuration for crush.
377type Config struct {
378 Schema string `json:"$schema,omitempty"`
379
380 // We currently only support large/small as values here.
381 Models map[SelectedModelType]SelectedModel `json:"models,omitempty" jsonschema:"description=Model configurations for different model types,example={\"large\":{\"model\":\"gpt-4o\",\"provider\":\"openai\"}}"`
382
383 // Recently used models stored in the data directory config.
384 RecentModels map[SelectedModelType][]SelectedModel `json:"recent_models,omitempty" jsonschema:"-"`
385
386 // The providers that are configured
387 Providers *csync.Map[string, ProviderConfig] `json:"providers,omitempty" jsonschema:"description=AI provider configurations"`
388
389 MCP MCPs `json:"mcp,omitempty" jsonschema:"description=Model Context Protocol server configurations"`
390
391 LSP LSPs `json:"lsp,omitempty" jsonschema:"description=Language Server Protocol configurations"`
392
393 Options *Options `json:"options,omitempty" jsonschema:"description=General application options"`
394
395 Permissions *Permissions `json:"permissions,omitempty" jsonschema:"description=Permission settings for tool usage"`
396
397 Tools Tools `json:"tools,omitzero" jsonschema:"description=Tool configurations"`
398
399 Agents map[string]Agent `json:"-"`
400
401 // Internal
402 workingDir string `json:"-"`
403 // TODO: find a better way to do this this should probably not be part of the config
404 resolver VariableResolver
405 dataConfigDir string `json:"-"`
406 knownProviders []catwalk.Provider `json:"-"`
407}
408
409func (c *Config) WorkingDir() string {
410 return c.workingDir
411}
412
413func (c *Config) EnabledProviders() []ProviderConfig {
414 var enabled []ProviderConfig
415 for p := range c.Providers.Seq() {
416 if !p.Disable {
417 enabled = append(enabled, p)
418 }
419 }
420 return enabled
421}
422
423// IsConfigured return true if at least one provider is configured
424func (c *Config) IsConfigured() bool {
425 return len(c.EnabledProviders()) > 0
426}
427
428func (c *Config) GetModel(provider, model string) *catwalk.Model {
429 if providerConfig, ok := c.Providers.Get(provider); ok {
430 for _, m := range providerConfig.Models {
431 if m.ID == model {
432 return &m
433 }
434 }
435 }
436 return nil
437}
438
439func (c *Config) GetProviderForModel(modelType SelectedModelType) *ProviderConfig {
440 model, ok := c.Models[modelType]
441 if !ok {
442 return nil
443 }
444 if providerConfig, ok := c.Providers.Get(model.Provider); ok {
445 return &providerConfig
446 }
447 return nil
448}
449
450func (c *Config) GetModelByType(modelType SelectedModelType) *catwalk.Model {
451 model, ok := c.Models[modelType]
452 if !ok {
453 return nil
454 }
455 return c.GetModel(model.Provider, model.Model)
456}
457
458func (c *Config) LargeModel() *catwalk.Model {
459 model, ok := c.Models[SelectedModelTypeLarge]
460 if !ok {
461 return nil
462 }
463 return c.GetModel(model.Provider, model.Model)
464}
465
466func (c *Config) SmallModel() *catwalk.Model {
467 model, ok := c.Models[SelectedModelTypeSmall]
468 if !ok {
469 return nil
470 }
471 return c.GetModel(model.Provider, model.Model)
472}
473
474func (c *Config) SetCompactMode(enabled bool) error {
475 if c.Options == nil {
476 c.Options = &Options{}
477 }
478 c.Options.TUI.CompactMode = enabled
479 return c.SetConfigField("options.tui.compact_mode", enabled)
480}
481
482func (c *Config) Resolve(key string) (string, error) {
483 if c.resolver == nil {
484 return "", fmt.Errorf("no variable resolver configured")
485 }
486 return c.resolver.ResolveValue(key)
487}
488
489func (c *Config) UpdatePreferredModel(modelType SelectedModelType, model SelectedModel) error {
490 c.Models[modelType] = model
491 if err := c.SetConfigField(fmt.Sprintf("models.%s", modelType), model); err != nil {
492 return fmt.Errorf("failed to update preferred model: %w", err)
493 }
494 if err := c.recordRecentModel(modelType, model); err != nil {
495 return err
496 }
497 return nil
498}
499
500func (c *Config) HasConfigField(key string) bool {
501 data, err := os.ReadFile(c.dataConfigDir)
502 if err != nil {
503 return false
504 }
505 return gjson.Get(string(data), key).Exists()
506}
507
508func (c *Config) SetConfigField(key string, value any) error {
509 data, err := os.ReadFile(c.dataConfigDir)
510 if err != nil {
511 if os.IsNotExist(err) {
512 data = []byte("{}")
513 } else {
514 return fmt.Errorf("failed to read config file: %w", err)
515 }
516 }
517
518 newValue, err := sjson.Set(string(data), key, value)
519 if err != nil {
520 return fmt.Errorf("failed to set config field %s: %w", key, err)
521 }
522 if err := os.MkdirAll(filepath.Dir(c.dataConfigDir), 0o755); err != nil {
523 return fmt.Errorf("failed to create config directory %q: %w", c.dataConfigDir, err)
524 }
525 if err := os.WriteFile(c.dataConfigDir, []byte(newValue), 0o600); err != nil {
526 return fmt.Errorf("failed to write config file: %w", err)
527 }
528 return nil
529}
530
531func (c *Config) RemoveConfigField(key string) error {
532 data, err := os.ReadFile(c.dataConfigDir)
533 if err != nil {
534 return fmt.Errorf("failed to read config file: %w", err)
535 }
536
537 newValue, err := sjson.Delete(string(data), key)
538 if err != nil {
539 return fmt.Errorf("failed to delete config field %s: %w", key, err)
540 }
541 if err := os.MkdirAll(filepath.Dir(c.dataConfigDir), 0o755); err != nil {
542 return fmt.Errorf("failed to create config directory %q: %w", c.dataConfigDir, err)
543 }
544 if err := os.WriteFile(c.dataConfigDir, []byte(newValue), 0o600); err != nil {
545 return fmt.Errorf("failed to write config file: %w", err)
546 }
547 return nil
548}
549
550// RefreshOAuthToken refreshes the OAuth token for the given provider.
551func (c *Config) RefreshOAuthToken(ctx context.Context, providerID string) error {
552 providerConfig, exists := c.Providers.Get(providerID)
553 if !exists {
554 return fmt.Errorf("provider %s not found", providerID)
555 }
556
557 if providerConfig.OAuthToken == nil {
558 return fmt.Errorf("provider %s does not have an OAuth token", providerID)
559 }
560
561 var newToken *oauth.Token
562 var refreshErr error
563 switch providerID {
564 case string(catwalk.InferenceProviderCopilot):
565 newToken, refreshErr = copilot.RefreshToken(ctx, providerConfig.OAuthToken.RefreshToken)
566 case hyperp.Name:
567 newToken, refreshErr = hyper.ExchangeToken(ctx, providerConfig.OAuthToken.RefreshToken)
568 default:
569 return fmt.Errorf("OAuth refresh not supported for provider %s", providerID)
570 }
571 if refreshErr != nil {
572 return fmt.Errorf("failed to refresh OAuth token for provider %s: %w", providerID, refreshErr)
573 }
574
575 slog.Info("Successfully refreshed OAuth token", "provider", providerID)
576 providerConfig.OAuthToken = newToken
577 providerConfig.APIKey = newToken.AccessToken
578
579 switch providerID {
580 case string(catwalk.InferenceProviderCopilot):
581 providerConfig.SetupGitHubCopilot()
582 }
583
584 c.Providers.Set(providerID, providerConfig)
585
586 if err := cmp.Or(
587 c.SetConfigField(fmt.Sprintf("providers.%s.api_key", providerID), newToken.AccessToken),
588 c.SetConfigField(fmt.Sprintf("providers.%s.oauth", providerID), newToken),
589 ); err != nil {
590 return fmt.Errorf("failed to persist refreshed token: %w", err)
591 }
592
593 return nil
594}
595
596func (c *Config) SetProviderAPIKey(providerID string, apiKey any) error {
597 var providerConfig ProviderConfig
598 var exists bool
599 var setKeyOrToken func()
600
601 switch v := apiKey.(type) {
602 case string:
603 if err := c.SetConfigField(fmt.Sprintf("providers.%s.api_key", providerID), v); err != nil {
604 return fmt.Errorf("failed to save api key to config file: %w", err)
605 }
606 setKeyOrToken = func() { providerConfig.APIKey = v }
607 case *oauth.Token:
608 if err := cmp.Or(
609 c.SetConfigField(fmt.Sprintf("providers.%s.api_key", providerID), v.AccessToken),
610 c.SetConfigField(fmt.Sprintf("providers.%s.oauth", providerID), v),
611 ); err != nil {
612 return err
613 }
614 setKeyOrToken = func() {
615 providerConfig.APIKey = v.AccessToken
616 providerConfig.OAuthToken = v
617 switch providerID {
618 case string(catwalk.InferenceProviderCopilot):
619 providerConfig.SetupGitHubCopilot()
620 }
621 }
622 }
623
624 providerConfig, exists = c.Providers.Get(providerID)
625 if exists {
626 setKeyOrToken()
627 c.Providers.Set(providerID, providerConfig)
628 return nil
629 }
630
631 var foundProvider *catwalk.Provider
632 for _, p := range c.knownProviders {
633 if string(p.ID) == providerID {
634 foundProvider = &p
635 break
636 }
637 }
638
639 if foundProvider != nil {
640 // Create new provider config based on known provider
641 providerConfig = ProviderConfig{
642 ID: providerID,
643 Name: foundProvider.Name,
644 BaseURL: foundProvider.APIEndpoint,
645 Type: foundProvider.Type,
646 Disable: false,
647 ExtraHeaders: make(map[string]string),
648 ExtraParams: make(map[string]string),
649 Models: foundProvider.Models,
650 }
651 setKeyOrToken()
652 } else {
653 return fmt.Errorf("provider with ID %s not found in known providers", providerID)
654 }
655 // Store the updated provider config
656 c.Providers.Set(providerID, providerConfig)
657 return nil
658}
659
660const maxRecentModelsPerType = 5
661
662func (c *Config) recordRecentModel(modelType SelectedModelType, model SelectedModel) error {
663 if model.Provider == "" || model.Model == "" {
664 return nil
665 }
666
667 if c.RecentModels == nil {
668 c.RecentModels = make(map[SelectedModelType][]SelectedModel)
669 }
670
671 eq := func(a, b SelectedModel) bool {
672 return a.Provider == b.Provider && a.Model == b.Model
673 }
674
675 entry := SelectedModel{
676 Provider: model.Provider,
677 Model: model.Model,
678 }
679
680 current := c.RecentModels[modelType]
681 withoutCurrent := slices.DeleteFunc(slices.Clone(current), func(existing SelectedModel) bool {
682 return eq(existing, entry)
683 })
684
685 updated := append([]SelectedModel{entry}, withoutCurrent...)
686 if len(updated) > maxRecentModelsPerType {
687 updated = updated[:maxRecentModelsPerType]
688 }
689
690 if slices.EqualFunc(current, updated, eq) {
691 return nil
692 }
693
694 c.RecentModels[modelType] = updated
695
696 if err := c.SetConfigField(fmt.Sprintf("recent_models.%s", modelType), updated); err != nil {
697 return fmt.Errorf("failed to persist recent models: %w", err)
698 }
699
700 return nil
701}
702
703func allToolNames() []string {
704 return []string{
705 "agent",
706 "bash",
707 "job_output",
708 "job_kill",
709 "download",
710 "edit",
711 "multiedit",
712 "lsp_diagnostics",
713 "lsp_references",
714 "lsp_restart",
715 "fetch",
716 "agentic_fetch",
717 "glob",
718 "grep",
719 "ls",
720 "sourcegraph",
721 "todos",
722 "view",
723 "write",
724 "list_mcp_resources",
725 "read_mcp_resource",
726 }
727}
728
729func resolveAllowedTools(allTools []string, disabledTools []string) []string {
730 if disabledTools == nil {
731 return allTools
732 }
733 // filter out disabled tools (exclude mode)
734 return filterSlice(allTools, disabledTools, false)
735}
736
737func resolveReadOnlyTools(tools []string) []string {
738 readOnlyTools := []string{"glob", "grep", "ls", "sourcegraph", "view"}
739 // filter to only include tools that are in allowedtools (include mode)
740 return filterSlice(tools, readOnlyTools, true)
741}
742
743func filterSlice(data []string, mask []string, include bool) []string {
744 var filtered []string
745 for _, s := range data {
746 // if include is true, we include items that ARE in the mask
747 // if include is false, we include items that are NOT in the mask
748 if include == slices.Contains(mask, s) {
749 filtered = append(filtered, s)
750 }
751 }
752 return filtered
753}
754
755func (c *Config) SetupAgents() {
756 allowedTools := resolveAllowedTools(allToolNames(), c.Options.DisabledTools)
757
758 agents := map[string]Agent{
759 AgentCoder: {
760 ID: AgentCoder,
761 Name: "Coder",
762 Description: "An agent that helps with executing coding tasks.",
763 Model: SelectedModelTypeLarge,
764 ContextPaths: c.Options.ContextPaths,
765 AllowedTools: allowedTools,
766 },
767
768 AgentTask: {
769 ID: AgentTask,
770 Name: "Task",
771 Description: "An agent that helps with searching for context and finding implementation details.",
772 Model: SelectedModelTypeLarge,
773 ContextPaths: c.Options.ContextPaths,
774 AllowedTools: resolveReadOnlyTools(allowedTools),
775 // NO MCPs or LSPs by default
776 AllowedMCP: map[string][]string{},
777 },
778 }
779 c.Agents = agents
780}
781
782func (c *Config) Resolver() VariableResolver {
783 return c.resolver
784}
785
786func (c *ProviderConfig) TestConnection(resolver VariableResolver) error {
787 var (
788 providerID = catwalk.InferenceProvider(c.ID)
789 testURL = ""
790 headers = make(map[string]string)
791 apiKey, _ = resolver.ResolveValue(c.APIKey)
792 )
793
794 switch providerID {
795 case catwalk.InferenceProviderMiniMax, catwalk.InferenceProviderMiniMaxChina:
796 // NOTE: MiniMax has no good endpoint we can use to validate the API key.
797 // Let's at least check the pattern.
798 if !strings.HasPrefix(apiKey, "sk-") {
799 return fmt.Errorf("invalid API key format for provider %s", c.ID)
800 }
801 return nil
802 }
803
804 switch c.Type {
805 case catwalk.TypeOpenAI, catwalk.TypeOpenAICompat, catwalk.TypeOpenRouter:
806 baseURL, _ := resolver.ResolveValue(c.BaseURL)
807 baseURL = cmp.Or(baseURL, "https://api.openai.com/v1")
808
809 switch providerID {
810 case catwalk.InferenceProviderOpenRouter:
811 testURL = baseURL + "/credits"
812 default:
813 testURL = baseURL + "/models"
814 }
815
816 headers["Authorization"] = "Bearer " + apiKey
817 case catwalk.TypeAnthropic:
818 baseURL, _ := resolver.ResolveValue(c.BaseURL)
819 baseURL = cmp.Or(baseURL, "https://api.anthropic.com/v1")
820
821 switch providerID {
822 case catwalk.InferenceKimiCoding:
823 testURL = baseURL + "/v1/models"
824 default:
825 testURL = baseURL + "/models"
826 }
827
828 headers["x-api-key"] = apiKey
829 headers["anthropic-version"] = "2023-06-01"
830 case catwalk.TypeGoogle:
831 baseURL, _ := resolver.ResolveValue(c.BaseURL)
832 baseURL = cmp.Or(baseURL, "https://generativelanguage.googleapis.com")
833 testURL = baseURL + "/v1beta/models?key=" + url.QueryEscape(apiKey)
834 }
835
836 ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
837 defer cancel()
838
839 client := &http.Client{}
840 req, err := http.NewRequestWithContext(ctx, "GET", testURL, nil)
841 if err != nil {
842 return fmt.Errorf("failed to create request for provider %s: %w", c.ID, err)
843 }
844 for k, v := range headers {
845 req.Header.Set(k, v)
846 }
847 for k, v := range c.ExtraHeaders {
848 req.Header.Set(k, v)
849 }
850
851 resp, err := client.Do(req)
852 if err != nil {
853 return fmt.Errorf("failed to create request for provider %s: %w", c.ID, err)
854 }
855 defer resp.Body.Close()
856
857 switch providerID {
858 case catwalk.InferenceProviderZAI:
859 if resp.StatusCode == http.StatusUnauthorized {
860 return fmt.Errorf("failed to connect to provider %s: %s", c.ID, resp.Status)
861 }
862 default:
863 if resp.StatusCode != http.StatusOK {
864 return fmt.Errorf("failed to connect to provider %s: %s", c.ID, resp.Status)
865 }
866 }
867 return nil
868}
869
870func resolveEnvs(envs map[string]string) []string {
871 resolver := NewShellVariableResolver(env.New())
872 for e, v := range envs {
873 var err error
874 envs[e], err = resolver.ResolveValue(v)
875 if err != nil {
876 slog.Error("Error resolving environment variable", "error", err, "variable", e, "value", v)
877 continue
878 }
879 }
880
881 res := make([]string, 0, len(envs))
882 for k, v := range envs {
883 res = append(res, fmt.Sprintf("%s=%s", k, v))
884 }
885 return res
886}
887
888func ptrValOr[T any](t *T, el T) T {
889 if t == nil {
890 return el
891 }
892 return *t
893}