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