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