| package config |
|
|
| import ( |
| "context" |
| "fmt" |
| "log/slog" |
| "net/http" |
| "net/url" |
| "os" |
| "slices" |
| "strings" |
| "time" |
|
|
| "github.com/charmbracelet/catwalk/pkg/catwalk" |
| "github.com/charmbracelet/crush/internal/csync" |
| "github.com/charmbracelet/crush/internal/env" |
| "github.com/tidwall/sjson" |
| ) |
|
|
| const ( |
| appName = "crush" |
| defaultDataDirectory = ".crush" |
| ) |
|
|
| var defaultContextPaths = []string{ |
| ".github/copilot-instructions.md", |
| ".cursorrules", |
| ".cursor/rules/", |
| "CLAUDE.md", |
| "CLAUDE.local.md", |
| "GEMINI.md", |
| "gemini.md", |
| "crush.md", |
| "crush.local.md", |
| "Crush.md", |
| "Crush.local.md", |
| "CRUSH.md", |
| "CRUSH.local.md", |
| "AGENTS.md", |
| "agents.md", |
| "Agents.md", |
| } |
|
|
| type SelectedModelType string |
|
|
| const ( |
| SelectedModelTypeLarge SelectedModelType = "large" |
| SelectedModelTypeSmall SelectedModelType = "small" |
| ) |
|
|
| type SelectedModel struct { |
| |
| |
| Model string `json:"model" jsonschema:"required,description=The model ID as used by the provider API,example=gpt-4o"` |
| |
| |
| Provider string `json:"provider" jsonschema:"required,description=The model provider ID that matches a key in the providers config,example=openai"` |
|
|
| |
| ReasoningEffort string `json:"reasoning_effort,omitempty" jsonschema:"description=Reasoning effort level for OpenAI models that support it,enum=low,enum=medium,enum=high"` |
|
|
| |
| MaxTokens int64 `json:"max_tokens,omitempty" jsonschema:"description=Maximum number of tokens for model responses,minimum=1,maximum=200000,example=4096"` |
|
|
| |
| Think bool `json:"think,omitempty" jsonschema:"description=Enable thinking mode for Anthropic models that support reasoning"` |
| } |
|
|
| type ProviderConfig struct { |
| |
| ID string `json:"id,omitempty" jsonschema:"description=Unique identifier for the provider,example=openai"` |
| |
| Name string `json:"name,omitempty" jsonschema:"description=Human-readable name for the provider,example=OpenAI"` |
| |
| BaseURL string `json:"base_url,omitempty" jsonschema:"description=Base URL for the provider's API,format=uri,example=https://api.openai.com/v1"` |
| |
| 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"` |
| |
| APIKey string `json:"api_key,omitempty" jsonschema:"description=API key for authentication with the provider,example=$OPENAI_API_KEY"` |
| |
| Disable bool `json:"disable,omitempty" jsonschema:"description=Whether this provider is disabled,default=false"` |
|
|
| |
| SystemPromptPrefix string `json:"system_prompt_prefix,omitempty" jsonschema:"description=Custom prefix to add to system prompts for this provider"` |
|
|
| |
| ExtraHeaders map[string]string `json:"extra_headers,omitempty" jsonschema:"description=Additional HTTP headers to send with requests"` |
| |
| ExtraBody map[string]any `json:"extra_body,omitempty" jsonschema:"description=Additional fields to include in request bodies"` |
|
|
| |
| ExtraParams map[string]string `json:"-"` |
|
|
| |
| Models []catwalk.Model `json:"models,omitempty" jsonschema:"description=List of models available from this provider"` |
| } |
|
|
| type MCPType string |
|
|
| const ( |
| MCPStdio MCPType = "stdio" |
| MCPSse MCPType = "sse" |
| MCPHttp MCPType = "http" |
| ) |
|
|
| type MCPConfig struct { |
| Command string `json:"command,omitempty" jsonschema:"description=Command to execute for stdio MCP servers,example=npx"` |
| Env map[string]string `json:"env,omitempty" jsonschema:"description=Environment variables to set for the MCP server"` |
| Args []string `json:"args,omitempty" jsonschema:"description=Arguments to pass to the MCP server command"` |
| Type MCPType `json:"type" jsonschema:"required,description=Type of MCP connection,enum=stdio,enum=sse,enum=http,default=stdio"` |
| URL string `json:"url,omitempty" jsonschema:"description=URL for HTTP or SSE MCP servers,format=uri,example=http://localhost:3000/mcp"` |
| Disabled bool `json:"disabled,omitempty" jsonschema:"description=Whether this MCP server is disabled,default=false"` |
| Timeout int `json:"timeout,omitempty" jsonschema:"description=Timeout in seconds for MCP server connections,default=15,example=30,example=60,example=120"` |
|
|
| |
| Headers map[string]string `json:"headers,omitempty" jsonschema:"description=HTTP headers for HTTP/SSE MCP servers"` |
| } |
|
|
| type LSPConfig struct { |
| Disabled bool `json:"enabled,omitempty" jsonschema:"description=Whether this LSP server is disabled,default=false"` |
| Command string `json:"command" jsonschema:"required,description=Command to execute for the LSP server,example=gopls"` |
| Args []string `json:"args,omitempty" jsonschema:"description=Arguments to pass to the LSP server command"` |
| Env map[string]string `json:"env,omitempty" jsonschema:"description=Environment variables to set to the LSP server command"` |
| Options any `json:"options,omitempty" jsonschema:"description=LSP server-specific configuration options"` |
| 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"` |
| } |
|
|
| type TUIOptions struct { |
| CompactMode bool `json:"compact_mode,omitempty" jsonschema:"description=Enable compact mode for the TUI interface,default=false"` |
| DiffMode string `json:"diff_mode,omitempty" jsonschema:"description=Diff mode for the TUI interface,enum=unified,enum=split"` |
| |
| } |
|
|
| type Permissions struct { |
| AllowedTools []string `json:"allowed_tools,omitempty" jsonschema:"description=List of tools that don't require permission prompts,example=bash,example=view"` |
| SkipRequests bool `json:"-"` |
| } |
|
|
| type Options struct { |
| ContextPaths []string `json:"context_paths,omitempty" jsonschema:"description=Paths to files containing context information for the AI,example=.cursorrules,example=CRUSH.md"` |
| TUI *TUIOptions `json:"tui,omitempty" jsonschema:"description=Terminal user interface options"` |
| Debug bool `json:"debug,omitempty" jsonschema:"description=Enable debug logging,default=false"` |
| DebugLSP bool `json:"debug_lsp,omitempty" jsonschema:"description=Enable debug logging for LSP servers,default=false"` |
| DisableAutoSummarize bool `json:"disable_auto_summarize,omitempty" jsonschema:"description=Disable automatic conversation summarization,default=false"` |
| DataDirectory string `json:"data_directory,omitempty" jsonschema:"description=Directory for storing application data (relative to working directory),default=.crush,example=.crush"` |
| } |
|
|
| type MCPs map[string]MCPConfig |
|
|
| type MCP struct { |
| Name string `json:"name"` |
| MCP MCPConfig `json:"mcp"` |
| } |
|
|
| func (m MCPs) Sorted() []MCP { |
| sorted := make([]MCP, 0, len(m)) |
| for k, v := range m { |
| sorted = append(sorted, MCP{ |
| Name: k, |
| MCP: v, |
| }) |
| } |
| slices.SortFunc(sorted, func(a, b MCP) int { |
| return strings.Compare(a.Name, b.Name) |
| }) |
| return sorted |
| } |
|
|
| type LSPs map[string]LSPConfig |
|
|
| type LSP struct { |
| Name string `json:"name"` |
| LSP LSPConfig `json:"lsp"` |
| } |
|
|
| func (l LSPs) Sorted() []LSP { |
| sorted := make([]LSP, 0, len(l)) |
| for k, v := range l { |
| sorted = append(sorted, LSP{ |
| Name: k, |
| LSP: v, |
| }) |
| } |
| slices.SortFunc(sorted, func(a, b LSP) int { |
| return strings.Compare(a.Name, b.Name) |
| }) |
| return sorted |
| } |
|
|
| func (l LSPConfig) ResolvedEnv() []string { |
| return resolveEnvs(l.Env) |
| } |
|
|
| func (m MCPConfig) ResolvedEnv() []string { |
| return resolveEnvs(m.Env) |
| } |
|
|
| func (m MCPConfig) ResolvedHeaders() map[string]string { |
| resolver := NewShellVariableResolver(env.New()) |
| for e, v := range m.Headers { |
| var err error |
| m.Headers[e], err = resolver.ResolveValue(v) |
| if err != nil { |
| slog.Error("error resolving header variable", "error", err, "variable", e, "value", v) |
| continue |
| } |
| } |
| return m.Headers |
| } |
|
|
| type Agent struct { |
| ID string `json:"id,omitempty"` |
| Name string `json:"name,omitempty"` |
| Description string `json:"description,omitempty"` |
| |
| Disabled bool `json:"disabled,omitempty"` |
|
|
| Model SelectedModelType `json:"model" jsonschema:"required,description=The model type to use for this agent,enum=large,enum=small,default=large"` |
|
|
| |
| |
| AllowedTools []string `json:"allowed_tools,omitempty"` |
|
|
| |
| |
| |
| |
| AllowedMCP map[string][]string `json:"allowed_mcp,omitempty"` |
|
|
| |
| |
| AllowedLSP []string `json:"allowed_lsp,omitempty"` |
|
|
| |
| ContextPaths []string `json:"context_paths,omitempty"` |
| } |
|
|
| |
| type Config struct { |
| Schema string `json:"$schema,omitempty"` |
|
|
| |
| Models map[SelectedModelType]SelectedModel `json:"models,omitempty" jsonschema:"description=Model configurations for different model types,example={\"large\":{\"model\":\"gpt-4o\",\"provider\":\"openai\"}}"` |
|
|
| |
| Providers *csync.Map[string, ProviderConfig] `json:"providers,omitempty" jsonschema:"description=AI provider configurations"` |
|
|
| MCP MCPs `json:"mcp,omitempty" jsonschema:"description=Model Context Protocol server configurations"` |
|
|
| LSP LSPs `json:"lsp,omitempty" jsonschema:"description=Language Server Protocol configurations"` |
|
|
| Options *Options `json:"options,omitempty" jsonschema:"description=General application options"` |
|
|
| Permissions *Permissions `json:"permissions,omitempty" jsonschema:"description=Permission settings for tool usage"` |
|
|
| |
| workingDir string `json:"-"` |
| |
| Agents map[string]Agent `json:"-"` |
| |
| resolver VariableResolver |
| dataConfigDir string `json:"-"` |
| knownProviders []catwalk.Provider `json:"-"` |
| } |
|
|
| func (c *Config) WorkingDir() string { |
| return c.workingDir |
| } |
|
|
| func (c *Config) EnabledProviders() []ProviderConfig { |
| var enabled []ProviderConfig |
| for p := range c.Providers.Seq() { |
| if !p.Disable { |
| enabled = append(enabled, p) |
| } |
| } |
| return enabled |
| } |
|
|
| |
| func (c *Config) IsConfigured() bool { |
| return len(c.EnabledProviders()) > 0 |
| } |
|
|
| func (c *Config) GetModel(provider, model string) *catwalk.Model { |
| if providerConfig, ok := c.Providers.Get(provider); ok { |
| for _, m := range providerConfig.Models { |
| if m.ID == model { |
| return &m |
| } |
| } |
| } |
| return nil |
| } |
|
|
| func (c *Config) GetProviderForModel(modelType SelectedModelType) *ProviderConfig { |
| model, ok := c.Models[modelType] |
| if !ok { |
| return nil |
| } |
| if providerConfig, ok := c.Providers.Get(model.Provider); ok { |
| return &providerConfig |
| } |
| return nil |
| } |
|
|
| func (c *Config) GetModelByType(modelType SelectedModelType) *catwalk.Model { |
| model, ok := c.Models[modelType] |
| if !ok { |
| return nil |
| } |
| return c.GetModel(model.Provider, model.Model) |
| } |
|
|
| func (c *Config) LargeModel() *catwalk.Model { |
| model, ok := c.Models[SelectedModelTypeLarge] |
| if !ok { |
| return nil |
| } |
| return c.GetModel(model.Provider, model.Model) |
| } |
|
|
| func (c *Config) SmallModel() *catwalk.Model { |
| model, ok := c.Models[SelectedModelTypeSmall] |
| if !ok { |
| return nil |
| } |
| return c.GetModel(model.Provider, model.Model) |
| } |
|
|
| func (c *Config) SetCompactMode(enabled bool) error { |
| if c.Options == nil { |
| c.Options = &Options{} |
| } |
| c.Options.TUI.CompactMode = enabled |
| return c.SetConfigField("options.tui.compact_mode", enabled) |
| } |
|
|
| func (c *Config) Resolve(key string) (string, error) { |
| if c.resolver == nil { |
| return "", fmt.Errorf("no variable resolver configured") |
| } |
| return c.resolver.ResolveValue(key) |
| } |
|
|
| func (c *Config) UpdatePreferredModel(modelType SelectedModelType, model SelectedModel) error { |
| c.Models[modelType] = model |
| if err := c.SetConfigField(fmt.Sprintf("models.%s", modelType), model); err != nil { |
| return fmt.Errorf("failed to update preferred model: %w", err) |
| } |
| return nil |
| } |
|
|
| func (c *Config) SetConfigField(key string, value any) error { |
| |
| data, err := os.ReadFile(c.dataConfigDir) |
| if err != nil { |
| if os.IsNotExist(err) { |
| data = []byte("{}") |
| } else { |
| return fmt.Errorf("failed to read config file: %w", err) |
| } |
| } |
|
|
| newValue, err := sjson.Set(string(data), key, value) |
| if err != nil { |
| return fmt.Errorf("failed to set config field %s: %w", key, err) |
| } |
| if err := os.WriteFile(c.dataConfigDir, []byte(newValue), 0o600); err != nil { |
| return fmt.Errorf("failed to write config file: %w", err) |
| } |
| return nil |
| } |
|
|
| func (c *Config) SetProviderAPIKey(providerID, apiKey string) error { |
| |
| err := c.SetConfigField("providers."+providerID+".api_key", apiKey) |
| if err != nil { |
| return fmt.Errorf("failed to save API key to config file: %w", err) |
| } |
|
|
| providerConfig, exists := c.Providers.Get(providerID) |
| if exists { |
| providerConfig.APIKey = apiKey |
| c.Providers.Set(providerID, providerConfig) |
| return nil |
| } |
|
|
| var foundProvider *catwalk.Provider |
| for _, p := range c.knownProviders { |
| if string(p.ID) == providerID { |
| foundProvider = &p |
| break |
| } |
| } |
|
|
| if foundProvider != nil { |
| |
| providerConfig = ProviderConfig{ |
| ID: providerID, |
| Name: foundProvider.Name, |
| BaseURL: foundProvider.APIEndpoint, |
| Type: foundProvider.Type, |
| APIKey: apiKey, |
| Disable: false, |
| ExtraHeaders: make(map[string]string), |
| ExtraParams: make(map[string]string), |
| Models: foundProvider.Models, |
| } |
| } else { |
| return fmt.Errorf("provider with ID %s not found in known providers", providerID) |
| } |
| |
| c.Providers.Set(providerID, providerConfig) |
| return nil |
| } |
|
|
| func (c *Config) SetupAgents() { |
| agents := map[string]Agent{ |
| "coder": { |
| ID: "coder", |
| Name: "Coder", |
| Description: "An agent that helps with executing coding tasks.", |
| Model: SelectedModelTypeLarge, |
| ContextPaths: c.Options.ContextPaths, |
| |
| }, |
| "task": { |
| ID: "task", |
| Name: "Task", |
| Description: "An agent that helps with searching for context and finding implementation details.", |
| Model: SelectedModelTypeLarge, |
| ContextPaths: c.Options.ContextPaths, |
| AllowedTools: []string{ |
| "glob", |
| "grep", |
| "ls", |
| "sourcegraph", |
| "view", |
| }, |
| |
| AllowedMCP: map[string][]string{}, |
| AllowedLSP: []string{}, |
| }, |
| } |
| c.Agents = agents |
| } |
|
|
| func (c *Config) Resolver() VariableResolver { |
| return c.resolver |
| } |
|
|
| func (c *ProviderConfig) TestConnection(resolver VariableResolver) error { |
| testURL := "" |
| headers := make(map[string]string) |
| apiKey, _ := resolver.ResolveValue(c.APIKey) |
| switch c.Type { |
| case catwalk.TypeOpenAI: |
| baseURL, _ := resolver.ResolveValue(c.BaseURL) |
| if baseURL == "" { |
| baseURL = "https://api.openai.com/v1" |
| } |
| testURL = baseURL + "/models" |
| headers["Authorization"] = "Bearer " + apiKey |
| case catwalk.TypeAnthropic: |
| baseURL, _ := resolver.ResolveValue(c.BaseURL) |
| if baseURL == "" { |
| baseURL = "https://api.anthropic.com/v1" |
| } |
| testURL = baseURL + "/models" |
| headers["x-api-key"] = apiKey |
| headers["anthropic-version"] = "2023-06-01" |
| case catwalk.TypeGemini: |
| baseURL, _ := resolver.ResolveValue(c.BaseURL) |
| if baseURL == "" { |
| baseURL = "https://generativelanguage.googleapis.com" |
| } |
| testURL = baseURL + "/v1beta/models?key=" + url.QueryEscape(apiKey) |
| } |
| ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) |
| defer cancel() |
| client := &http.Client{} |
| req, err := http.NewRequestWithContext(ctx, "GET", testURL, nil) |
| if err != nil { |
| return fmt.Errorf("failed to create request for provider %s: %w", c.ID, err) |
| } |
| for k, v := range headers { |
| req.Header.Set(k, v) |
| } |
| for k, v := range c.ExtraHeaders { |
| req.Header.Set(k, v) |
| } |
| b, err := client.Do(req) |
| if err != nil { |
| return fmt.Errorf("failed to create request for provider %s: %w", c.ID, err) |
| } |
| if b.StatusCode != http.StatusOK { |
| return fmt.Errorf("failed to connect to provider %s: %s", c.ID, b.Status) |
| } |
| _ = b.Body.Close() |
| return nil |
| } |
|
|
| func resolveEnvs(envs map[string]string) []string { |
| resolver := NewShellVariableResolver(env.New()) |
| for e, v := range envs { |
| var err error |
| envs[e], err = resolver.ResolveValue(v) |
| if err != nil { |
| slog.Error("error resolving environment variable", "error", err, "variable", e, "value", v) |
| continue |
| } |
| } |
|
|
| res := make([]string, 0, len(envs)) |
| for k, v := range envs { |
| res = append(res, fmt.Sprintf("%s=%s", k, v)) |
| } |
| return res |
| } |
|
|