1package config
2
3import (
4 "context"
5 "fmt"
6 "log/slog"
7 "net/http"
8 "net/url"
9 "os"
10 "slices"
11 "strings"
12 "time"
13
14 "github.com/charmbracelet/catwalk/pkg/catwalk"
15 "github.com/charmbracelet/crush/internal/csync"
16 "github.com/charmbracelet/crush/internal/env"
17 "github.com/tidwall/sjson"
18)
19
20const (
21 appName = "crush"
22 defaultDataDirectory = ".crush"
23)
24
25var defaultContextPaths = []string{
26 ".github/copilot-instructions.md",
27 ".cursorrules",
28 ".cursor/rules/",
29 "CLAUDE.md",
30 "CLAUDE.local.md",
31 "GEMINI.md",
32 "gemini.md",
33 "crush.md",
34 "crush.local.md",
35 "Crush.md",
36 "Crush.local.md",
37 "CRUSH.md",
38 "CRUSH.local.md",
39 "AGENTS.md",
40 "agents.md",
41 "Agents.md",
42}
43
44type SelectedModelType string
45
46const (
47 SelectedModelTypeLarge SelectedModelType = "large"
48 SelectedModelTypeSmall SelectedModelType = "small"
49)
50
51type SelectedModel struct {
52 // The model id as used by the provider API.
53 // Required.
54 Model string `json:"model" jsonschema:"required,description=The model ID as used by the provider API,example=gpt-4o"`
55 // The model provider, same as the key/id used in the providers config.
56 // Required.
57 Provider string `json:"provider" jsonschema:"required,description=The model provider ID that matches a key in the providers config,example=openai"`
58
59 // Only used by models that use the openai provider and need this set.
60 ReasoningEffort string `json:"reasoning_effort,omitempty" jsonschema:"description=Reasoning effort level for OpenAI models that support it,enum=low,enum=medium,enum=high"`
61
62 // Overrides the default model configuration.
63 MaxTokens int64 `json:"max_tokens,omitempty" jsonschema:"description=Maximum number of tokens for model responses,minimum=1,maximum=200000,example=4096"`
64
65 // Used by anthropic models that can reason to indicate if the model should think.
66 Think bool `json:"think,omitempty" jsonschema:"description=Enable thinking mode for Anthropic models that support reasoning"`
67}
68
69type ProviderConfig struct {
70 // The provider's id.
71 ID string `json:"id,omitempty" jsonschema:"description=Unique identifier for the provider,example=openai"`
72 // The provider's name, used for display purposes.
73 Name string `json:"name,omitempty" jsonschema:"description=Human-readable name for the provider,example=OpenAI"`
74 // The provider's API endpoint.
75 BaseURL string `json:"base_url,omitempty" jsonschema:"description=Base URL for the provider's API,format=uri,example=https://api.openai.com/v1"`
76 // The provider type, e.g. "openai", "anthropic", etc. if empty it defaults to openai.
77 Type catwalk.Type `json:"type,omitempty" jsonschema:"description=Provider type that determines the API format,enum=openai,enum=anthropic,enum=gemini,enum=azure,enum=vertexai,default=openai"`
78 // The provider's API key.
79 APIKey string `json:"api_key,omitempty" jsonschema:"description=API key for authentication with the provider,example=$OPENAI_API_KEY"`
80 // Marks the provider as disabled.
81 Disable bool `json:"disable,omitempty" jsonschema:"description=Whether this provider is disabled,default=false"`
82
83 // Custom system prompt prefix.
84 SystemPromptPrefix string `json:"system_prompt_prefix,omitempty" jsonschema:"description=Custom prefix to add to system prompts for this provider"`
85
86 // Extra headers to send with each request to the provider.
87 ExtraHeaders map[string]string `json:"extra_headers,omitempty" jsonschema:"description=Additional HTTP headers to send with requests"`
88 // Extra body
89 ExtraBody map[string]any `json:"extra_body,omitempty" jsonschema:"description=Additional fields to include in request bodies"`
90
91 // Used to pass extra parameters to the provider.
92 ExtraParams map[string]string `json:"-"`
93
94 // The provider models
95 Models []catwalk.Model `json:"models,omitempty" jsonschema:"description=List of models available from this provider"`
96}
97
98type MCPType string
99
100const (
101 MCPStdio MCPType = "stdio"
102 MCPSse MCPType = "sse"
103 MCPHttp MCPType = "http"
104)
105
106type MCPConfig struct {
107 Command string `json:"command,omitempty" jsonschema:"description=Command to execute for stdio MCP servers,example=npx"`
108 Env map[string]string `json:"env,omitempty" jsonschema:"description=Environment variables to set for the MCP server"`
109 Args []string `json:"args,omitempty" jsonschema:"description=Arguments to pass to the MCP server command"`
110 Type MCPType `json:"type" jsonschema:"required,description=Type of MCP connection,enum=stdio,enum=sse,enum=http,default=stdio"`
111 URL string `json:"url,omitempty" jsonschema:"description=URL for HTTP or SSE MCP servers,format=uri,example=http://localhost:3000/mcp"`
112 Disabled bool `json:"disabled,omitempty" jsonschema:"description=Whether this MCP server is disabled,default=false"`
113 Timeout int `json:"timeout,omitempty" jsonschema:"description=Timeout in seconds for MCP server connections,default=15,example=30,example=60,example=120"`
114
115 // TODO: maybe make it possible to get the value from the env
116 Headers map[string]string `json:"headers,omitempty" jsonschema:"description=HTTP headers for HTTP/SSE MCP servers"`
117}
118
119type LSPConfig struct {
120 Disabled bool `json:"enabled,omitempty" jsonschema:"description=Whether this LSP server is disabled,default=false"`
121 Command string `json:"command" jsonschema:"required,description=Command to execute for the LSP server,example=gopls"`
122 Args []string `json:"args,omitempty" jsonschema:"description=Arguments to pass to the LSP server command"`
123 Env map[string]string `json:"env,omitempty" jsonschema:"description=Environment variables to set to the LSP server command"`
124 Options any `json:"options,omitempty" jsonschema:"description=LSP server-specific configuration options"`
125 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"`
126}
127
128type TUIOptions struct {
129 CompactMode bool `json:"compact_mode,omitempty" jsonschema:"description=Enable compact mode for the TUI interface,default=false"`
130 DiffMode string `json:"diff_mode,omitempty" jsonschema:"description=Diff mode for the TUI interface,enum=unified,enum=split"`
131 // Here we can add themes later or any TUI related options
132}
133
134type Permissions struct {
135 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
136 SkipRequests bool `json:"-"` // Automatically accept all permissions (YOLO mode)
137}
138
139type Options struct {
140 ContextPaths []string `json:"context_paths,omitempty" jsonschema:"description=Paths to files containing context information for the AI,example=.cursorrules,example=CRUSH.md"`
141 TUI *TUIOptions `json:"tui,omitempty" jsonschema:"description=Terminal user interface options"`
142 Debug bool `json:"debug,omitempty" jsonschema:"description=Enable debug logging,default=false"`
143 DebugLSP bool `json:"debug_lsp,omitempty" jsonschema:"description=Enable debug logging for LSP servers,default=false"`
144 DisableAutoSummarize bool `json:"disable_auto_summarize,omitempty" jsonschema:"description=Disable automatic conversation summarization,default=false"`
145 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
146 MaxMessages int `json:"max_messages,omitempty" jsonschema:"description=Maximum number of messages to keep in context (sliding window),default=50,minimum=10,maximum=200"`
147}
148
149type MCPs map[string]MCPConfig
150
151type MCP struct {
152 Name string `json:"name"`
153 MCP MCPConfig `json:"mcp"`
154}
155
156func (m MCPs) Sorted() []MCP {
157 sorted := make([]MCP, 0, len(m))
158 for k, v := range m {
159 sorted = append(sorted, MCP{
160 Name: k,
161 MCP: v,
162 })
163 }
164 slices.SortFunc(sorted, func(a, b MCP) int {
165 return strings.Compare(a.Name, b.Name)
166 })
167 return sorted
168}
169
170type LSPs map[string]LSPConfig
171
172type LSP struct {
173 Name string `json:"name"`
174 LSP LSPConfig `json:"lsp"`
175}
176
177func (l LSPs) Sorted() []LSP {
178 sorted := make([]LSP, 0, len(l))
179 for k, v := range l {
180 sorted = append(sorted, LSP{
181 Name: k,
182 LSP: v,
183 })
184 }
185 slices.SortFunc(sorted, func(a, b LSP) int {
186 return strings.Compare(a.Name, b.Name)
187 })
188 return sorted
189}
190
191func (l LSPConfig) ResolvedEnv() []string {
192 return resolveEnvs(l.Env)
193}
194
195func (m MCPConfig) ResolvedEnv() []string {
196 return resolveEnvs(m.Env)
197}
198
199func (m MCPConfig) ResolvedHeaders() map[string]string {
200 resolver := NewShellVariableResolver(env.New())
201 for e, v := range m.Headers {
202 var err error
203 m.Headers[e], err = resolver.ResolveValue(v)
204 if err != nil {
205 slog.Error("error resolving header variable", "error", err, "variable", e, "value", v)
206 continue
207 }
208 }
209 return m.Headers
210}
211
212type Agent struct {
213 ID string `json:"id,omitempty"`
214 Name string `json:"name,omitempty"`
215 Description string `json:"description,omitempty"`
216 // This is the id of the system prompt used by the agent
217 Disabled bool `json:"disabled,omitempty"`
218
219 Model SelectedModelType `json:"model" jsonschema:"required,description=The model type to use for this agent,enum=large,enum=small,default=large"`
220
221 // The available tools for the agent
222 // if this is nil, all tools are available
223 AllowedTools []string `json:"allowed_tools,omitempty"`
224
225 // this tells us which MCPs are available for this agent
226 // if this is empty all mcps are available
227 // the string array is the list of tools from the AllowedMCP the agent has available
228 // if the string array is nil, all tools from the AllowedMCP are available
229 AllowedMCP map[string][]string `json:"allowed_mcp,omitempty"`
230
231 // The list of LSPs that this agent can use
232 // if this is nil, all LSPs are available
233 AllowedLSP []string `json:"allowed_lsp,omitempty"`
234
235 // Overrides the context paths for this agent
236 ContextPaths []string `json:"context_paths,omitempty"`
237}
238
239// Config holds the configuration for crush.
240type Config struct {
241 Schema string `json:"$schema,omitempty"`
242
243 // We currently only support large/small as values here.
244 Models map[SelectedModelType]SelectedModel `json:"models,omitempty" jsonschema:"description=Model configurations for different model types,example={\"large\":{\"model\":\"gpt-4o\",\"provider\":\"openai\"}}"`
245
246 // The providers that are configured
247 Providers *csync.Map[string, ProviderConfig] `json:"providers,omitempty" jsonschema:"description=AI provider configurations"`
248
249 MCP MCPs `json:"mcp,omitempty" jsonschema:"description=Model Context Protocol server configurations"`
250
251 LSP LSPs `json:"lsp,omitempty" jsonschema:"description=Language Server Protocol configurations"`
252
253 Options *Options `json:"options,omitempty" jsonschema:"description=General application options"`
254
255 Permissions *Permissions `json:"permissions,omitempty" jsonschema:"description=Permission settings for tool usage"`
256
257 // Internal
258 workingDir string `json:"-"`
259 // TODO: most likely remove this concept when I come back to it
260 Agents map[string]Agent `json:"-"`
261 // TODO: find a better way to do this this should probably not be part of the config
262 resolver VariableResolver
263 dataConfigDir string `json:"-"`
264 knownProviders []catwalk.Provider `json:"-"`
265}
266
267func (c *Config) WorkingDir() string {
268 return c.workingDir
269}
270
271func (c *Config) EnabledProviders() []ProviderConfig {
272 var enabled []ProviderConfig
273 for p := range c.Providers.Seq() {
274 if !p.Disable {
275 enabled = append(enabled, p)
276 }
277 }
278 return enabled
279}
280
281// IsConfigured return true if at least one provider is configured
282func (c *Config) IsConfigured() bool {
283 return len(c.EnabledProviders()) > 0
284}
285
286func (c *Config) GetModel(provider, model string) *catwalk.Model {
287 if providerConfig, ok := c.Providers.Get(provider); ok {
288 for _, m := range providerConfig.Models {
289 if m.ID == model {
290 return &m
291 }
292 }
293 }
294 return nil
295}
296
297func (c *Config) GetProviderForModel(modelType SelectedModelType) *ProviderConfig {
298 model, ok := c.Models[modelType]
299 if !ok {
300 return nil
301 }
302 if providerConfig, ok := c.Providers.Get(model.Provider); ok {
303 return &providerConfig
304 }
305 return nil
306}
307
308func (c *Config) GetModelByType(modelType SelectedModelType) *catwalk.Model {
309 model, ok := c.Models[modelType]
310 if !ok {
311 return nil
312 }
313 return c.GetModel(model.Provider, model.Model)
314}
315
316func (c *Config) LargeModel() *catwalk.Model {
317 model, ok := c.Models[SelectedModelTypeLarge]
318 if !ok {
319 return nil
320 }
321 return c.GetModel(model.Provider, model.Model)
322}
323
324func (c *Config) SmallModel() *catwalk.Model {
325 model, ok := c.Models[SelectedModelTypeSmall]
326 if !ok {
327 return nil
328 }
329 return c.GetModel(model.Provider, model.Model)
330}
331
332func (c *Config) SetCompactMode(enabled bool) error {
333 if c.Options == nil {
334 c.Options = &Options{}
335 }
336 c.Options.TUI.CompactMode = enabled
337 return c.SetConfigField("options.tui.compact_mode", enabled)
338}
339
340func (c *Config) Resolve(key string) (string, error) {
341 if c.resolver == nil {
342 return "", fmt.Errorf("no variable resolver configured")
343 }
344 return c.resolver.ResolveValue(key)
345}
346
347func (c *Config) UpdatePreferredModel(modelType SelectedModelType, model SelectedModel) error {
348 c.Models[modelType] = model
349 if err := c.SetConfigField(fmt.Sprintf("models.%s", modelType), model); err != nil {
350 return fmt.Errorf("failed to update preferred model: %w", err)
351 }
352 return nil
353}
354
355func (c *Config) SetConfigField(key string, value any) error {
356 // read the data
357 data, err := os.ReadFile(c.dataConfigDir)
358 if err != nil {
359 if os.IsNotExist(err) {
360 data = []byte("{}")
361 } else {
362 return fmt.Errorf("failed to read config file: %w", err)
363 }
364 }
365
366 newValue, err := sjson.Set(string(data), key, value)
367 if err != nil {
368 return fmt.Errorf("failed to set config field %s: %w", key, err)
369 }
370 if err := os.WriteFile(c.dataConfigDir, []byte(newValue), 0o600); err != nil {
371 return fmt.Errorf("failed to write config file: %w", err)
372 }
373 return nil
374}
375
376func (c *Config) SetProviderAPIKey(providerID, apiKey string) error {
377 // First save to the config file
378 err := c.SetConfigField("providers."+providerID+".api_key", apiKey)
379 if err != nil {
380 return fmt.Errorf("failed to save API key to config file: %w", err)
381 }
382
383 providerConfig, exists := c.Providers.Get(providerID)
384 if exists {
385 providerConfig.APIKey = apiKey
386 c.Providers.Set(providerID, providerConfig)
387 return nil
388 }
389
390 var foundProvider *catwalk.Provider
391 for _, p := range c.knownProviders {
392 if string(p.ID) == providerID {
393 foundProvider = &p
394 break
395 }
396 }
397
398 if foundProvider != nil {
399 // Create new provider config based on known provider
400 providerConfig = ProviderConfig{
401 ID: providerID,
402 Name: foundProvider.Name,
403 BaseURL: foundProvider.APIEndpoint,
404 Type: foundProvider.Type,
405 APIKey: apiKey,
406 Disable: false,
407 ExtraHeaders: make(map[string]string),
408 ExtraParams: make(map[string]string),
409 Models: foundProvider.Models,
410 }
411 } else {
412 return fmt.Errorf("provider with ID %s not found in known providers", providerID)
413 }
414 // Store the updated provider config
415 c.Providers.Set(providerID, providerConfig)
416 return nil
417}
418
419func (c *Config) SetupAgents() {
420 agents := map[string]Agent{
421 "coder": {
422 ID: "coder",
423 Name: "Coder",
424 Description: "An agent that helps with executing coding tasks.",
425 Model: SelectedModelTypeLarge,
426 ContextPaths: c.Options.ContextPaths,
427 // All tools allowed
428 },
429 "task": {
430 ID: "task",
431 Name: "Task",
432 Description: "An agent that helps with searching for context and finding implementation details.",
433 Model: SelectedModelTypeLarge,
434 ContextPaths: c.Options.ContextPaths,
435 AllowedTools: []string{
436 "glob",
437 "grep",
438 "ls",
439 "sourcegraph",
440 "view",
441 },
442 // NO MCPs or LSPs by default
443 AllowedMCP: map[string][]string{},
444 AllowedLSP: []string{},
445 },
446 }
447 c.Agents = agents
448}
449
450func (c *Config) Resolver() VariableResolver {
451 return c.resolver
452}
453
454func (c *ProviderConfig) TestConnection(resolver VariableResolver) error {
455 testURL := ""
456 headers := make(map[string]string)
457 apiKey, _ := resolver.ResolveValue(c.APIKey)
458 switch c.Type {
459 case catwalk.TypeOpenAI:
460 baseURL, _ := resolver.ResolveValue(c.BaseURL)
461 if baseURL == "" {
462 baseURL = "https://api.openai.com/v1"
463 }
464 testURL = baseURL + "/models"
465 headers["Authorization"] = "Bearer " + apiKey
466 case catwalk.TypeAnthropic:
467 baseURL, _ := resolver.ResolveValue(c.BaseURL)
468 if baseURL == "" {
469 baseURL = "https://api.anthropic.com/v1"
470 }
471 testURL = baseURL + "/models"
472 headers["x-api-key"] = apiKey
473 headers["anthropic-version"] = "2023-06-01"
474 case catwalk.TypeGemini:
475 baseURL, _ := resolver.ResolveValue(c.BaseURL)
476 if baseURL == "" {
477 baseURL = "https://generativelanguage.googleapis.com"
478 }
479 testURL = baseURL + "/v1beta/models?key=" + url.QueryEscape(apiKey)
480 }
481 ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
482 defer cancel()
483 client := &http.Client{}
484 req, err := http.NewRequestWithContext(ctx, "GET", testURL, nil)
485 if err != nil {
486 return fmt.Errorf("failed to create request for provider %s: %w", c.ID, err)
487 }
488 for k, v := range headers {
489 req.Header.Set(k, v)
490 }
491 for k, v := range c.ExtraHeaders {
492 req.Header.Set(k, v)
493 }
494 b, err := client.Do(req)
495 if err != nil {
496 return fmt.Errorf("failed to create request for provider %s: %w", c.ID, err)
497 }
498 if b.StatusCode != http.StatusOK {
499 return fmt.Errorf("failed to connect to provider %s: %s", c.ID, b.Status)
500 }
501 _ = b.Body.Close()
502 return nil
503}
504
505func resolveEnvs(envs map[string]string) []string {
506 resolver := NewShellVariableResolver(env.New())
507 for e, v := range envs {
508 var err error
509 envs[e], err = resolver.ResolveValue(v)
510 if err != nil {
511 slog.Error("error resolving environment variable", "error", err, "variable", e, "value", v)
512 continue
513 }
514 }
515
516 res := make([]string, 0, len(envs))
517 for k, v := range envs {
518 res = append(res, fmt.Sprintf("%s=%s", k, v))
519 }
520 return res
521}