| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893 |
- package config
- import (
- "cmp"
- "context"
- "fmt"
- "log/slog"
- "maps"
- "net/http"
- "net/url"
- "os"
- "path/filepath"
- "slices"
- "strings"
- "time"
- "charm.land/catwalk/pkg/catwalk"
- hyperp "github.com/charmbracelet/crush/internal/agent/hyper"
- "github.com/charmbracelet/crush/internal/csync"
- "github.com/charmbracelet/crush/internal/env"
- "github.com/charmbracelet/crush/internal/oauth"
- "github.com/charmbracelet/crush/internal/oauth/copilot"
- "github.com/charmbracelet/crush/internal/oauth/hyper"
- "github.com/invopop/jsonschema"
- "github.com/tidwall/gjson"
- "github.com/tidwall/sjson"
- )
- const (
- appName = "crush"
- defaultDataDirectory = ".crush"
- defaultInitializeAs = "AGENTS.md"
- )
- 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
- // String returns the string representation of the [SelectedModelType].
- func (s SelectedModelType) String() string {
- return string(s)
- }
- const (
- SelectedModelTypeLarge SelectedModelType = "large"
- SelectedModelTypeSmall SelectedModelType = "small"
- )
- const (
- AgentCoder string = "coder"
- AgentTask string = "task"
- )
- type SelectedModel struct {
- // The model id as used by the provider API.
- // Required.
- Model string `json:"model" jsonschema:"required,description=The model ID as used by the provider API,example=gpt-4o"`
- // The model provider, same as the key/id used in the providers config.
- // Required.
- Provider string `json:"provider" jsonschema:"required,description=The model provider ID that matches a key in the providers config,example=openai"`
- // Only used by models that use the openai provider and need this set.
- ReasoningEffort string `json:"reasoning_effort,omitempty" jsonschema:"description=Reasoning effort level for OpenAI models that support it,enum=low,enum=medium,enum=high"`
- // Used by anthropic models that can reason to indicate if the model should think.
- Think bool `json:"think,omitempty" jsonschema:"description=Enable thinking mode for Anthropic models that support reasoning"`
- // Overrides the default model configuration.
- MaxTokens int64 `json:"max_tokens,omitempty" jsonschema:"description=Maximum number of tokens for model responses,maximum=200000,example=4096"`
- Temperature *float64 `json:"temperature,omitempty" jsonschema:"description=Sampling temperature,minimum=0,maximum=1,example=0.7"`
- TopP *float64 `json:"top_p,omitempty" jsonschema:"description=Top-p (nucleus) sampling parameter,minimum=0,maximum=1,example=0.9"`
- TopK *int64 `json:"top_k,omitempty" jsonschema:"description=Top-k sampling parameter"`
- FrequencyPenalty *float64 `json:"frequency_penalty,omitempty" jsonschema:"description=Frequency penalty to reduce repetition"`
- PresencePenalty *float64 `json:"presence_penalty,omitempty" jsonschema:"description=Presence penalty to increase topic diversity"`
- // Override provider specific options.
- ProviderOptions map[string]any `json:"provider_options,omitempty" jsonschema:"description=Additional provider-specific options for the model"`
- }
- type ProviderConfig struct {
- // The provider's id.
- ID string `json:"id,omitempty" jsonschema:"description=Unique identifier for the provider,example=openai"`
- // The provider's name, used for display purposes.
- Name string `json:"name,omitempty" jsonschema:"description=Human-readable name for the provider,example=OpenAI"`
- // The provider's API endpoint.
- BaseURL string `json:"base_url,omitempty" jsonschema:"description=Base URL for the provider's API,format=uri,example=https://api.openai.com/v1"`
- // The provider type, e.g. "openai", "anthropic", etc. if empty it defaults to openai.
- 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"`
- // The provider's API key.
- APIKey string `json:"api_key,omitempty" jsonschema:"description=API key for authentication with the provider,example=$OPENAI_API_KEY"`
- // The original API key template before resolution (for re-resolution on auth errors).
- APIKeyTemplate string `json:"-"`
- // OAuthToken for providers that use OAuth2 authentication.
- OAuthToken *oauth.Token `json:"oauth,omitempty" jsonschema:"description=OAuth2 token for authentication with the provider"`
- // Marks the provider as disabled.
- Disable bool `json:"disable,omitempty" jsonschema:"description=Whether this provider is disabled,default=false"`
- // Custom system prompt prefix.
- SystemPromptPrefix string `json:"system_prompt_prefix,omitempty" jsonschema:"description=Custom prefix to add to system prompts for this provider"`
- // Extra headers to send with each request to the provider.
- ExtraHeaders map[string]string `json:"extra_headers,omitempty" jsonschema:"description=Additional HTTP headers to send with requests"`
- // Extra body
- ExtraBody map[string]any `json:"extra_body,omitempty" jsonschema:"description=Additional fields to include in request bodies, only works with openai-compatible providers"`
- ProviderOptions map[string]any `json:"provider_options,omitempty" jsonschema:"description=Additional provider-specific options for this provider"`
- // Used to pass extra parameters to the provider.
- ExtraParams map[string]string `json:"-"`
- // The provider models
- Models []catwalk.Model `json:"models,omitempty" jsonschema:"description=List of models available from this provider"`
- }
- // ToProvider converts the [ProviderConfig] to a [catwalk.Provider].
- func (pc *ProviderConfig) ToProvider() catwalk.Provider {
- // Convert config provider to provider.Provider format
- provider := catwalk.Provider{
- Name: pc.Name,
- ID: catwalk.InferenceProvider(pc.ID),
- Models: make([]catwalk.Model, len(pc.Models)),
- }
- // Convert models
- for i, model := range pc.Models {
- provider.Models[i] = catwalk.Model{
- ID: model.ID,
- Name: model.Name,
- CostPer1MIn: model.CostPer1MIn,
- CostPer1MOut: model.CostPer1MOut,
- CostPer1MInCached: model.CostPer1MInCached,
- CostPer1MOutCached: model.CostPer1MOutCached,
- ContextWindow: model.ContextWindow,
- DefaultMaxTokens: model.DefaultMaxTokens,
- CanReason: model.CanReason,
- ReasoningLevels: model.ReasoningLevels,
- DefaultReasoningEffort: model.DefaultReasoningEffort,
- SupportsImages: model.SupportsImages,
- }
- }
- return provider
- }
- func (pc *ProviderConfig) SetupGitHubCopilot() {
- maps.Copy(pc.ExtraHeaders, copilot.Headers())
- }
- 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"`
- DisabledTools []string `json:"disabled_tools,omitempty" jsonschema:"description=List of tools from this MCP server to disable,example=get-library-doc"`
- Timeout int `json:"timeout,omitempty" jsonschema:"description=Timeout in seconds for MCP server connections,default=15,example=30,example=60,example=120"`
- // TODO: maybe make it possible to get the value from the env
- Headers map[string]string `json:"headers,omitempty" jsonschema:"description=HTTP headers for HTTP/SSE MCP servers"`
- }
- type LSPConfig struct {
- Disabled bool `json:"disabled,omitempty" jsonschema:"description=Whether this LSP server is disabled,default=false"`
- Command string `json:"command,omitempty" jsonschema:"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"`
- 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"`
- 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"`
- InitOptions map[string]any `json:"init_options,omitempty" jsonschema:"description=Initialization options passed to the LSP server during initialize request"`
- Options map[string]any `json:"options,omitempty" jsonschema:"description=LSP server-specific settings passed during initialization"`
- Timeout int `json:"timeout,omitempty" jsonschema:"description=Timeout in seconds for LSP server initialization,default=30,example=60,example=120"`
- }
- 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"`
- // Here we can add themes later or any TUI related options
- //
- Completions Completions `json:"completions,omitzero" jsonschema:"description=Completions UI options"`
- Transparent *bool `json:"transparent,omitempty" jsonschema:"description=Enable transparent background for the TUI interface,default=false"`
- }
- // Completions defines options for the completions UI.
- type Completions struct {
- MaxDepth *int `json:"max_depth,omitempty" jsonschema:"description=Maximum depth for the ls tool,default=0,example=10"`
- MaxItems *int `json:"max_items,omitempty" jsonschema:"description=Maximum number of items to return for the ls tool,default=1000,example=100"`
- }
- func (c Completions) Limits() (depth, items int) {
- return ptrValOr(c.MaxDepth, 0), ptrValOr(c.MaxItems, 0)
- }
- type Permissions struct {
- 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
- SkipRequests bool `json:"-"` // Automatically accept all permissions (YOLO mode)
- }
- type TrailerStyle string
- const (
- TrailerStyleNone TrailerStyle = "none"
- TrailerStyleCoAuthoredBy TrailerStyle = "co-authored-by"
- TrailerStyleAssistedBy TrailerStyle = "assisted-by"
- )
- type Attribution struct {
- 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"`
- CoAuthoredBy *bool `json:"co_authored_by,omitempty" jsonschema:"description=Deprecated: use trailer_style instead"`
- GeneratedWith bool `json:"generated_with,omitempty" jsonschema:"description=Add Generated with Crush line to commit messages and issues and PRs,default=true"`
- }
- // JSONSchemaExtend marks the co_authored_by field as deprecated in the schema.
- func (Attribution) JSONSchemaExtend(schema *jsonschema.Schema) {
- if schema.Properties != nil {
- if prop, ok := schema.Properties.Get("co_authored_by"); ok {
- prop.Deprecated = true
- }
- }
- }
- 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"`
- 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"`
- 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"` // Relative to the cwd
- DisabledTools []string `json:"disabled_tools,omitempty" jsonschema:"description=List of built-in tools to disable and hide from the agent,example=bash,example=sourcegraph"`
- DisableProviderAutoUpdate bool `json:"disable_provider_auto_update,omitempty" jsonschema:"description=Disable providers auto-update,default=false"`
- 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"`
- Attribution *Attribution `json:"attribution,omitempty" jsonschema:"description=Attribution settings for generated content"`
- DisableMetrics bool `json:"disable_metrics,omitempty" jsonschema:"description=Disable sending metrics,default=false"`
- 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"`
- AutoLSP *bool `json:"auto_lsp,omitempty" jsonschema:"description=Automatically setup LSPs based on root markers,default=true"`
- Progress *bool `json:"progress,omitempty" jsonschema:"description=Show indeterminate progress updates during long operations,default=true"`
- }
- 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"`
- // This is the id of the system prompt used by the agent
- 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"`
- // The available tools for the agent
- // if this is nil, all tools are available
- AllowedTools []string `json:"allowed_tools,omitempty"`
- // this tells us which MCPs are available for this agent
- // if this is empty all mcps are available
- // the string array is the list of tools from the AllowedMCP the agent has available
- // if the string array is nil, all tools from the AllowedMCP are available
- AllowedMCP map[string][]string `json:"allowed_mcp,omitempty"`
- // Overrides the context paths for this agent
- ContextPaths []string `json:"context_paths,omitempty"`
- }
- type Tools struct {
- Ls ToolLs `json:"ls,omitzero"`
- Grep ToolGrep `json:"grep,omitzero"`
- }
- type ToolLs struct {
- MaxDepth *int `json:"max_depth,omitempty" jsonschema:"description=Maximum depth for the ls tool,default=0,example=10"`
- MaxItems *int `json:"max_items,omitempty" jsonschema:"description=Maximum number of items to return for the ls tool,default=1000,example=100"`
- }
- // Limits returns the user-defined max-depth and max-items, or their defaults.
- func (t ToolLs) Limits() (depth, items int) {
- return ptrValOr(t.MaxDepth, 0), ptrValOr(t.MaxItems, 0)
- }
- type ToolGrep struct {
- Timeout *time.Duration `json:"timeout,omitempty" jsonschema:"description=Timeout for the grep tool call,default=5s,example=10s"`
- }
- // GetTimeout returns the user-defined timeout or the default.
- func (t ToolGrep) GetTimeout() time.Duration {
- return ptrValOr(t.Timeout, 5*time.Second)
- }
- // Config holds the configuration for crush.
- type Config struct {
- Schema string `json:"$schema,omitempty"`
- // We currently only support large/small as values here.
- Models map[SelectedModelType]SelectedModel `json:"models,omitempty" jsonschema:"description=Model configurations for different model types,example={\"large\":{\"model\":\"gpt-4o\",\"provider\":\"openai\"}}"`
- // Recently used models stored in the data directory config.
- RecentModels map[SelectedModelType][]SelectedModel `json:"recent_models,omitempty" jsonschema:"-"`
- // The providers that are configured
- 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"`
- Tools Tools `json:"tools,omitzero" jsonschema:"description=Tool configurations"`
- Agents map[string]Agent `json:"-"`
- // Internal
- workingDir string `json:"-"`
- // TODO: find a better way to do this this should probably not be part of the config
- 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
- }
- // IsConfigured return true if at least one provider is configured
- 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)
- }
- if err := c.recordRecentModel(modelType, model); err != nil {
- return err
- }
- return nil
- }
- func (c *Config) HasConfigField(key string) bool {
- data, err := os.ReadFile(c.dataConfigDir)
- if err != nil {
- return false
- }
- return gjson.Get(string(data), key).Exists()
- }
- 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.MkdirAll(filepath.Dir(c.dataConfigDir), 0o755); err != nil {
- return fmt.Errorf("failed to create config directory %q: %w", c.dataConfigDir, 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) RemoveConfigField(key string) error {
- data, err := os.ReadFile(c.dataConfigDir)
- if err != nil {
- return fmt.Errorf("failed to read config file: %w", err)
- }
- newValue, err := sjson.Delete(string(data), key)
- if err != nil {
- return fmt.Errorf("failed to delete config field %s: %w", key, err)
- }
- if err := os.MkdirAll(filepath.Dir(c.dataConfigDir), 0o755); err != nil {
- return fmt.Errorf("failed to create config directory %q: %w", c.dataConfigDir, err)
- }
- if err := os.WriteFile(c.dataConfigDir, []byte(newValue), 0o600); err != nil {
- return fmt.Errorf("failed to write config file: %w", err)
- }
- return nil
- }
- // RefreshOAuthToken refreshes the OAuth token for the given provider.
- func (c *Config) RefreshOAuthToken(ctx context.Context, providerID string) error {
- providerConfig, exists := c.Providers.Get(providerID)
- if !exists {
- return fmt.Errorf("provider %s not found", providerID)
- }
- if providerConfig.OAuthToken == nil {
- return fmt.Errorf("provider %s does not have an OAuth token", providerID)
- }
- var newToken *oauth.Token
- var refreshErr error
- switch providerID {
- case string(catwalk.InferenceProviderCopilot):
- newToken, refreshErr = copilot.RefreshToken(ctx, providerConfig.OAuthToken.RefreshToken)
- case hyperp.Name:
- newToken, refreshErr = hyper.ExchangeToken(ctx, providerConfig.OAuthToken.RefreshToken)
- default:
- return fmt.Errorf("OAuth refresh not supported for provider %s", providerID)
- }
- if refreshErr != nil {
- return fmt.Errorf("failed to refresh OAuth token for provider %s: %w", providerID, refreshErr)
- }
- slog.Info("Successfully refreshed OAuth token", "provider", providerID)
- providerConfig.OAuthToken = newToken
- providerConfig.APIKey = newToken.AccessToken
- switch providerID {
- case string(catwalk.InferenceProviderCopilot):
- providerConfig.SetupGitHubCopilot()
- }
- c.Providers.Set(providerID, providerConfig)
- if err := cmp.Or(
- c.SetConfigField(fmt.Sprintf("providers.%s.api_key", providerID), newToken.AccessToken),
- c.SetConfigField(fmt.Sprintf("providers.%s.oauth", providerID), newToken),
- ); err != nil {
- return fmt.Errorf("failed to persist refreshed token: %w", err)
- }
- return nil
- }
- func (c *Config) SetProviderAPIKey(providerID string, apiKey any) error {
- var providerConfig ProviderConfig
- var exists bool
- var setKeyOrToken func()
- switch v := apiKey.(type) {
- case string:
- if err := c.SetConfigField(fmt.Sprintf("providers.%s.api_key", providerID), v); err != nil {
- return fmt.Errorf("failed to save api key to config file: %w", err)
- }
- setKeyOrToken = func() { providerConfig.APIKey = v }
- case *oauth.Token:
- if err := cmp.Or(
- c.SetConfigField(fmt.Sprintf("providers.%s.api_key", providerID), v.AccessToken),
- c.SetConfigField(fmt.Sprintf("providers.%s.oauth", providerID), v),
- ); err != nil {
- return err
- }
- setKeyOrToken = func() {
- providerConfig.APIKey = v.AccessToken
- providerConfig.OAuthToken = v
- switch providerID {
- case string(catwalk.InferenceProviderCopilot):
- providerConfig.SetupGitHubCopilot()
- }
- }
- }
- providerConfig, exists = c.Providers.Get(providerID)
- if exists {
- setKeyOrToken()
- 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 {
- // Create new provider config based on known provider
- providerConfig = ProviderConfig{
- ID: providerID,
- Name: foundProvider.Name,
- BaseURL: foundProvider.APIEndpoint,
- Type: foundProvider.Type,
- Disable: false,
- ExtraHeaders: make(map[string]string),
- ExtraParams: make(map[string]string),
- Models: foundProvider.Models,
- }
- setKeyOrToken()
- } else {
- return fmt.Errorf("provider with ID %s not found in known providers", providerID)
- }
- // Store the updated provider config
- c.Providers.Set(providerID, providerConfig)
- return nil
- }
- const maxRecentModelsPerType = 5
- func (c *Config) recordRecentModel(modelType SelectedModelType, model SelectedModel) error {
- if model.Provider == "" || model.Model == "" {
- return nil
- }
- if c.RecentModels == nil {
- c.RecentModels = make(map[SelectedModelType][]SelectedModel)
- }
- eq := func(a, b SelectedModel) bool {
- return a.Provider == b.Provider && a.Model == b.Model
- }
- entry := SelectedModel{
- Provider: model.Provider,
- Model: model.Model,
- }
- current := c.RecentModels[modelType]
- withoutCurrent := slices.DeleteFunc(slices.Clone(current), func(existing SelectedModel) bool {
- return eq(existing, entry)
- })
- updated := append([]SelectedModel{entry}, withoutCurrent...)
- if len(updated) > maxRecentModelsPerType {
- updated = updated[:maxRecentModelsPerType]
- }
- if slices.EqualFunc(current, updated, eq) {
- return nil
- }
- c.RecentModels[modelType] = updated
- if err := c.SetConfigField(fmt.Sprintf("recent_models.%s", modelType), updated); err != nil {
- return fmt.Errorf("failed to persist recent models: %w", err)
- }
- return nil
- }
- func allToolNames() []string {
- return []string{
- "agent",
- "bash",
- "job_output",
- "job_kill",
- "download",
- "edit",
- "multiedit",
- "lsp_diagnostics",
- "lsp_references",
- "lsp_restart",
- "fetch",
- "agentic_fetch",
- "glob",
- "grep",
- "ls",
- "sourcegraph",
- "todos",
- "view",
- "write",
- "list_mcp_resources",
- "read_mcp_resource",
- }
- }
- func resolveAllowedTools(allTools []string, disabledTools []string) []string {
- if disabledTools == nil {
- return allTools
- }
- // filter out disabled tools (exclude mode)
- return filterSlice(allTools, disabledTools, false)
- }
- func resolveReadOnlyTools(tools []string) []string {
- readOnlyTools := []string{"glob", "grep", "ls", "sourcegraph", "view"}
- // filter to only include tools that are in allowedtools (include mode)
- return filterSlice(tools, readOnlyTools, true)
- }
- func filterSlice(data []string, mask []string, include bool) []string {
- var filtered []string
- for _, s := range data {
- // if include is true, we include items that ARE in the mask
- // if include is false, we include items that are NOT in the mask
- if include == slices.Contains(mask, s) {
- filtered = append(filtered, s)
- }
- }
- return filtered
- }
- func (c *Config) SetupAgents() {
- allowedTools := resolveAllowedTools(allToolNames(), c.Options.DisabledTools)
- agents := map[string]Agent{
- AgentCoder: {
- ID: AgentCoder,
- Name: "Coder",
- Description: "An agent that helps with executing coding tasks.",
- Model: SelectedModelTypeLarge,
- ContextPaths: c.Options.ContextPaths,
- AllowedTools: allowedTools,
- },
- AgentTask: {
- ID: AgentTask,
- Name: "Task",
- Description: "An agent that helps with searching for context and finding implementation details.",
- Model: SelectedModelTypeLarge,
- ContextPaths: c.Options.ContextPaths,
- AllowedTools: resolveReadOnlyTools(allowedTools),
- // NO MCPs or LSPs by default
- AllowedMCP: map[string][]string{},
- },
- }
- c.Agents = agents
- }
- func (c *Config) Resolver() VariableResolver {
- return c.resolver
- }
- func (c *ProviderConfig) TestConnection(resolver VariableResolver) error {
- var (
- providerID = catwalk.InferenceProvider(c.ID)
- testURL = ""
- headers = make(map[string]string)
- apiKey, _ = resolver.ResolveValue(c.APIKey)
- )
- switch providerID {
- case catwalk.InferenceProviderMiniMax:
- // NOTE: MiniMax has no good endpoint we can use to validate the API key.
- // Let's at least check the pattern.
- if !strings.HasPrefix(apiKey, "sk-") {
- return fmt.Errorf("invalid API key format for provider %s", c.ID)
- }
- return nil
- }
- switch c.Type {
- case catwalk.TypeOpenAI, catwalk.TypeOpenAICompat, catwalk.TypeOpenRouter:
- baseURL, _ := resolver.ResolveValue(c.BaseURL)
- baseURL = cmp.Or(baseURL, "https://api.openai.com/v1")
- switch providerID {
- case catwalk.InferenceProviderOpenRouter:
- testURL = baseURL + "/credits"
- default:
- testURL = baseURL + "/models"
- }
- headers["Authorization"] = "Bearer " + apiKey
- case catwalk.TypeAnthropic:
- baseURL, _ := resolver.ResolveValue(c.BaseURL)
- baseURL = cmp.Or(baseURL, "https://api.anthropic.com/v1")
- switch providerID {
- case catwalk.InferenceKimiCoding:
- testURL = baseURL + "/v1/models"
- default:
- testURL = baseURL + "/models"
- }
- headers["x-api-key"] = apiKey
- headers["anthropic-version"] = "2023-06-01"
- case catwalk.TypeGoogle:
- baseURL, _ := resolver.ResolveValue(c.BaseURL)
- baseURL = cmp.Or(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)
- }
- resp, err := client.Do(req)
- if err != nil {
- return fmt.Errorf("failed to create request for provider %s: %w", c.ID, err)
- }
- defer resp.Body.Close()
- switch providerID {
- case catwalk.InferenceProviderZAI:
- if resp.StatusCode == http.StatusUnauthorized {
- return fmt.Errorf("failed to connect to provider %s: %s", c.ID, resp.Status)
- }
- default:
- if resp.StatusCode != http.StatusOK {
- return fmt.Errorf("failed to connect to provider %s: %s", c.ID, resp.Status)
- }
- }
- 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
- }
- func ptrValOr[T any](t *T, el T) T {
- if t == nil {
- return el
- }
- return *t
- }
|