config.go

  1package config
  2
  3import (
  4	"cmp"
  5	"context"
  6	"errors"
  7	"fmt"
  8	"log/slog"
  9	"maps"
 10	"net/http"
 11	"net/url"
 12	"slices"
 13	"strings"
 14	"time"
 15
 16	"charm.land/catwalk/pkg/catwalk"
 17	"github.com/charmbracelet/crush/internal/csync"
 18	"github.com/charmbracelet/crush/internal/env"
 19	"github.com/charmbracelet/crush/internal/oauth"
 20	"github.com/charmbracelet/crush/internal/oauth/copilot"
 21	"github.com/invopop/jsonschema"
 22)
 23
 24const (
 25	appName              = "crush"
 26	defaultDataDirectory = ".crush"
 27	defaultInitializeAs  = "AGENTS.md"
 28)
 29
 30var defaultContextPaths = []string{
 31	".github/copilot-instructions.md",
 32	".cursorrules",
 33	".cursor/rules/",
 34	"CLAUDE.md",
 35	"CLAUDE.local.md",
 36	"GEMINI.md",
 37	"gemini.md",
 38	"crush.md",
 39	"crush.local.md",
 40	"Crush.md",
 41	"Crush.local.md",
 42	"CRUSH.md",
 43	"CRUSH.local.md",
 44	"AGENTS.md",
 45	"agents.md",
 46	"Agents.md",
 47}
 48
 49type SelectedModelType string
 50
 51// String returns the string representation of the [SelectedModelType].
 52func (s SelectedModelType) String() string {
 53	return string(s)
 54}
 55
 56const (
 57	SelectedModelTypeLarge SelectedModelType = "large"
 58	SelectedModelTypeSmall SelectedModelType = "small"
 59)
 60
 61const (
 62	AgentCoder string = "coder"
 63	AgentTask  string = "task"
 64)
 65
 66type SelectedModel struct {
 67	// The model id as used by the provider API.
 68	// Required.
 69	Model string `json:"model" jsonschema:"required,description=The model ID as used by the provider API,example=gpt-4o"`
 70	// The model provider, same as the key/id used in the providers config.
 71	// Required.
 72	Provider string `json:"provider" jsonschema:"required,description=The model provider ID that matches a key in the providers config,example=openai"`
 73
 74	// Only used by models that use the openai provider and need this set.
 75	ReasoningEffort string `json:"reasoning_effort,omitempty" jsonschema:"description=Reasoning effort level for OpenAI models that support it,enum=low,enum=medium,enum=high"`
 76
 77	// Used by anthropic models that can reason to indicate if the model should think.
 78	Think bool `json:"think,omitempty" jsonschema:"description=Enable thinking mode for Anthropic models that support reasoning"`
 79
 80	// Overrides the default model configuration.
 81	MaxTokens        int64    `json:"max_tokens,omitempty" jsonschema:"description=Maximum number of tokens for model responses,maximum=200000,example=4096"`
 82	Temperature      *float64 `json:"temperature,omitempty" jsonschema:"description=Sampling temperature,minimum=0,maximum=1,example=0.7"`
 83	TopP             *float64 `json:"top_p,omitempty" jsonschema:"description=Top-p (nucleus) sampling parameter,minimum=0,maximum=1,example=0.9"`
 84	TopK             *int64   `json:"top_k,omitempty" jsonschema:"description=Top-k sampling parameter"`
 85	FrequencyPenalty *float64 `json:"frequency_penalty,omitempty" jsonschema:"description=Frequency penalty to reduce repetition"`
 86	PresencePenalty  *float64 `json:"presence_penalty,omitempty" jsonschema:"description=Presence penalty to increase topic diversity"`
 87
 88	// Override provider specific options.
 89	ProviderOptions map[string]any `json:"provider_options,omitempty" jsonschema:"description=Additional provider-specific options for the model"`
 90}
 91
 92type ProviderConfig struct {
 93	// The provider's id.
 94	ID string `json:"id,omitempty" jsonschema:"description=Unique identifier for the provider,example=openai"`
 95	// The provider's name, used for display purposes.
 96	Name string `json:"name,omitempty" jsonschema:"description=Human-readable name for the provider,example=OpenAI"`
 97	// The provider's API endpoint.
 98	BaseURL string `json:"base_url,omitempty" jsonschema:"description=Base URL for the provider's API,format=uri,example=https://api.openai.com/v1"`
 99	// The provider type, e.g. "openai", "anthropic", etc. if empty it defaults to openai.
100	Type catwalk.Type `json:"type,omitempty" jsonschema:"description=Provider type that determines the API format,enum=openai,enum=openai-compat,enum=anthropic,enum=gemini,enum=azure,enum=vertexai,default=openai"`
101	// The provider's API key.
102	APIKey string `json:"api_key,omitempty" jsonschema:"description=API key for authentication with the provider,example=$OPENAI_API_KEY"`
103	// The original API key template before resolution (for re-resolution on auth errors).
104	APIKeyTemplate string `json:"-"`
105	// OAuthToken for providers that use OAuth2 authentication.
106	OAuthToken *oauth.Token `json:"oauth,omitempty" jsonschema:"description=OAuth2 token for authentication with the provider"`
107	// Marks the provider as disabled.
108	Disable bool `json:"disable,omitempty" jsonschema:"description=Whether this provider is disabled,default=false"`
109
110	// Custom system prompt prefix.
111	SystemPromptPrefix string `json:"system_prompt_prefix,omitempty" jsonschema:"description=Custom prefix to add to system prompts for this provider"`
112
113	// Extra headers to send with each request to the provider.
114	ExtraHeaders map[string]string `json:"extra_headers,omitempty" jsonschema:"description=Additional HTTP headers to send with requests"`
115	// Extra body
116	ExtraBody map[string]any `json:"extra_body,omitempty" jsonschema:"description=Additional fields to include in request bodies, only works with openai-compatible providers"`
117
118	ProviderOptions map[string]any `json:"provider_options,omitempty" jsonschema:"description=Additional provider-specific options for this provider"`
119
120	// Used to pass extra parameters to the provider.
121	ExtraParams map[string]string `json:"-"`
122
123	// The provider models
124	Models []catwalk.Model `json:"models,omitempty" jsonschema:"description=List of models available from this provider"`
125}
126
127// ToProvider converts the [ProviderConfig] to a [catwalk.Provider].
128func (c *ProviderConfig) ToProvider() catwalk.Provider {
129	// Convert config provider to provider.Provider format
130	provider := catwalk.Provider{
131		Name:   c.Name,
132		ID:     catwalk.InferenceProvider(c.ID),
133		Models: make([]catwalk.Model, len(c.Models)),
134	}
135
136	// Convert models
137	for i, model := range c.Models {
138		provider.Models[i] = catwalk.Model{
139			ID:                     model.ID,
140			Name:                   model.Name,
141			CostPer1MIn:            model.CostPer1MIn,
142			CostPer1MOut:           model.CostPer1MOut,
143			CostPer1MInCached:      model.CostPer1MInCached,
144			CostPer1MOutCached:     model.CostPer1MOutCached,
145			ContextWindow:          model.ContextWindow,
146			DefaultMaxTokens:       model.DefaultMaxTokens,
147			CanReason:              model.CanReason,
148			ReasoningLevels:        model.ReasoningLevels,
149			DefaultReasoningEffort: model.DefaultReasoningEffort,
150			SupportsImages:         model.SupportsImages,
151		}
152	}
153
154	return provider
155}
156
157func (c *ProviderConfig) SetupGitHubCopilot() {
158	maps.Copy(c.ExtraHeaders, copilot.Headers())
159}
160
161type MCPType string
162
163const (
164	MCPStdio MCPType = "stdio"
165	MCPSSE   MCPType = "sse"
166	MCPHttp  MCPType = "http"
167)
168
169type MCPConfig struct {
170	Command       string            `json:"command,omitempty" jsonschema:"description=Command to execute for stdio MCP servers,example=npx"`
171	Env           map[string]string `json:"env,omitempty" jsonschema:"description=Environment variables to set for the MCP server"`
172	Args          []string          `json:"args,omitempty" jsonschema:"description=Arguments to pass to the MCP server command"`
173	Type          MCPType           `json:"type" jsonschema:"required,description=Type of MCP connection,enum=stdio,enum=sse,enum=http,default=stdio"`
174	URL           string            `json:"url,omitempty" jsonschema:"description=URL for HTTP or SSE MCP servers,format=uri,example=http://localhost:3000/mcp"`
175	Disabled      bool              `json:"disabled,omitempty" jsonschema:"description=Whether this MCP server is disabled,default=false"`
176	DisabledTools []string          `json:"disabled_tools,omitempty" jsonschema:"description=List of tools from this MCP server to disable,example=get-library-doc"`
177	Timeout       int               `json:"timeout,omitempty" jsonschema:"description=Timeout in seconds for MCP server connections,default=15,example=30,example=60,example=120"`
178
179	// TODO: maybe make it possible to get the value from the env
180	Headers map[string]string `json:"headers,omitempty" jsonschema:"description=HTTP headers for HTTP/SSE MCP servers"`
181}
182
183type LSPConfig struct {
184	Disabled    bool              `json:"disabled,omitempty" jsonschema:"description=Whether this LSP server is disabled,default=false"`
185	Command     string            `json:"command,omitempty" jsonschema:"description=Command to execute for the LSP server,example=gopls"`
186	Args        []string          `json:"args,omitempty" jsonschema:"description=Arguments to pass to the LSP server command"`
187	Env         map[string]string `json:"env,omitempty" jsonschema:"description=Environment variables to set to the LSP server command"`
188	FileTypes   []string          `json:"filetypes,omitempty" jsonschema:"description=File types this LSP server handles,example=go,example=mod,example=rs,example=c,example=js,example=ts"`
189	RootMarkers []string          `json:"root_markers,omitempty" jsonschema:"description=Files or directories that indicate the project root,example=go.mod,example=package.json,example=Cargo.toml"`
190	InitOptions map[string]any    `json:"init_options,omitempty" jsonschema:"description=Initialization options passed to the LSP server during initialize request"`
191	Options     map[string]any    `json:"options,omitempty" jsonschema:"description=LSP server-specific settings passed during initialization"`
192	Timeout     int               `json:"timeout,omitempty" jsonschema:"description=Timeout in seconds for LSP server initialization,default=30,example=60,example=120"`
193}
194
195type TUIOptions struct {
196	CompactMode bool   `json:"compact_mode,omitempty" jsonschema:"description=Enable compact mode for the TUI interface,default=false"`
197	DiffMode    string `json:"diff_mode,omitempty" jsonschema:"description=Diff mode for the TUI interface,enum=unified,enum=split"`
198	// Here we can add themes later or any TUI related options
199	//
200
201	Completions Completions `json:"completions,omitzero" jsonschema:"description=Completions UI options"`
202	Transparent *bool       `json:"transparent,omitempty" jsonschema:"description=Enable transparent background for the TUI interface,default=false"`
203}
204
205// Completions defines options for the completions UI.
206type Completions struct {
207	MaxDepth *int `json:"max_depth,omitempty" jsonschema:"description=Maximum depth for the ls tool,default=0,example=10"`
208	MaxItems *int `json:"max_items,omitempty" jsonschema:"description=Maximum number of items to return for the ls tool,default=1000,example=100"`
209}
210
211func (c Completions) Limits() (depth, items int) {
212	return ptrValOr(c.MaxDepth, 0), ptrValOr(c.MaxItems, 0)
213}
214
215type Permissions struct {
216	AllowedTools []string `json:"allowed_tools,omitempty" jsonschema:"description=List of tools that don't require permission prompts,example=bash,example=view"`
217}
218
219type TrailerStyle string
220
221const (
222	TrailerStyleNone         TrailerStyle = "none"
223	TrailerStyleCoAuthoredBy TrailerStyle = "co-authored-by"
224	TrailerStyleAssistedBy   TrailerStyle = "assisted-by"
225)
226
227type Attribution struct {
228	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"`
229	CoAuthoredBy  *bool        `json:"co_authored_by,omitempty" jsonschema:"description=Deprecated: use trailer_style instead"`
230	GeneratedWith bool         `json:"generated_with,omitempty" jsonschema:"description=Add Generated with Crush line to commit messages and issues and PRs,default=true"`
231}
232
233// JSONSchemaExtend marks the co_authored_by field as deprecated in the schema.
234func (Attribution) JSONSchemaExtend(schema *jsonschema.Schema) {
235	if schema.Properties != nil {
236		if prop, ok := schema.Properties.Get("co_authored_by"); ok {
237			prop.Deprecated = true
238		}
239	}
240}
241
242type Options struct {
243	ContextPaths              []string     `json:"context_paths,omitempty" jsonschema:"description=Paths to files containing context information for the AI,example=.cursorrules,example=CRUSH.md"`
244	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"`
245	TUI                       *TUIOptions  `json:"tui,omitempty" jsonschema:"description=Terminal user interface options"`
246	Debug                     bool         `json:"debug,omitempty" jsonschema:"description=Enable debug logging,default=false"`
247	DebugLSP                  bool         `json:"debug_lsp,omitempty" jsonschema:"description=Enable debug logging for LSP servers,default=false"`
248	DisableAutoSummarize      bool         `json:"disable_auto_summarize,omitempty" jsonschema:"description=Disable automatic conversation summarization,default=false"`
249	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
250	DisabledTools             []string     `json:"disabled_tools,omitempty" jsonschema:"description=List of built-in tools to disable and hide from the agent,example=bash,example=sourcegraph"`
251	DisableProviderAutoUpdate bool         `json:"disable_provider_auto_update,omitempty" jsonschema:"description=Disable providers auto-update,default=false"`
252	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"`
253	Attribution               *Attribution `json:"attribution,omitempty" jsonschema:"description=Attribution settings for generated content"`
254	DisableMetrics            bool         `json:"disable_metrics,omitempty" jsonschema:"description=Disable sending metrics,default=false"`
255	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"`
256	AutoLSP                   *bool        `json:"auto_lsp,omitempty" jsonschema:"description=Automatically setup LSPs based on root markers,default=true"`
257	Progress                  *bool        `json:"progress,omitempty" jsonschema:"description=Show indeterminate progress updates during long operations,default=true"`
258	DisableNotifications      bool         `json:"disable_notifications,omitempty" jsonschema:"description=Disable desktop notifications,default=false"`
259}
260
261type MCPs map[string]MCPConfig
262
263type MCP struct {
264	Name string    `json:"name"`
265	MCP  MCPConfig `json:"mcp"`
266}
267
268func (m MCPs) Sorted() []MCP {
269	sorted := make([]MCP, 0, len(m))
270	for k, v := range m {
271		sorted = append(sorted, MCP{
272			Name: k,
273			MCP:  v,
274		})
275	}
276	slices.SortFunc(sorted, func(a, b MCP) int {
277		return strings.Compare(a.Name, b.Name)
278	})
279	return sorted
280}
281
282type LSPs map[string]LSPConfig
283
284type LSP struct {
285	Name string    `json:"name"`
286	LSP  LSPConfig `json:"lsp"`
287}
288
289func (l LSPs) Sorted() []LSP {
290	sorted := make([]LSP, 0, len(l))
291	for k, v := range l {
292		sorted = append(sorted, LSP{
293			Name: k,
294			LSP:  v,
295		})
296	}
297	slices.SortFunc(sorted, func(a, b LSP) int {
298		return strings.Compare(a.Name, b.Name)
299	})
300	return sorted
301}
302
303func (l LSPConfig) ResolvedEnv() []string {
304	return resolveEnvs(l.Env)
305}
306
307func (m MCPConfig) ResolvedEnv() []string {
308	return resolveEnvs(m.Env)
309}
310
311func (m MCPConfig) ResolvedHeaders() map[string]string {
312	resolver := NewShellVariableResolver(env.New())
313	for e, v := range m.Headers {
314		var err error
315		m.Headers[e], err = resolver.ResolveValue(v)
316		if err != nil {
317			slog.Error("Error resolving header variable", "error", err, "variable", e, "value", v)
318			continue
319		}
320	}
321	return m.Headers
322}
323
324type Agent struct {
325	ID          string `json:"id,omitempty"`
326	Name        string `json:"name,omitempty"`
327	Description string `json:"description,omitempty"`
328	// This is the id of the system prompt used by the agent
329	Disabled bool `json:"disabled,omitempty"`
330
331	Model SelectedModelType `json:"model" jsonschema:"required,description=The model type to use for this agent,enum=large,enum=small,default=large"`
332
333	// The available tools for the agent
334	//  if this is nil, all tools are available
335	AllowedTools []string `json:"allowed_tools,omitempty"`
336
337	// this tells us which MCPs are available for this agent
338	//  if this is empty all mcps are available
339	//  the string array is the list of tools from the AllowedMCP the agent has available
340	//  if the string array is nil, all tools from the AllowedMCP are available
341	AllowedMCP map[string][]string `json:"allowed_mcp,omitempty"`
342
343	// Overrides the context paths for this agent
344	ContextPaths []string `json:"context_paths,omitempty"`
345}
346
347type Tools struct {
348	Ls   ToolLs   `json:"ls,omitzero"`
349	Grep ToolGrep `json:"grep,omitzero"`
350}
351
352type ToolLs struct {
353	MaxDepth *int `json:"max_depth,omitempty" jsonschema:"description=Maximum depth for the ls tool,default=0,example=10"`
354	MaxItems *int `json:"max_items,omitempty" jsonschema:"description=Maximum number of items to return for the ls tool,default=1000,example=100"`
355}
356
357// Limits returns the user-defined max-depth and max-items, or their defaults.
358func (t ToolLs) Limits() (depth, items int) {
359	return ptrValOr(t.MaxDepth, 0), ptrValOr(t.MaxItems, 0)
360}
361
362type ToolGrep struct {
363	Timeout *time.Duration `json:"timeout,omitempty" jsonschema:"description=Timeout for the grep tool call,default=5s,example=10s"`
364}
365
366// GetTimeout returns the user-defined timeout or the default.
367func (t ToolGrep) GetTimeout() time.Duration {
368	return ptrValOr(t.Timeout, 5*time.Second)
369}
370
371// Config holds the configuration for crush.
372type Config struct {
373	Schema string `json:"$schema,omitempty"`
374
375	// We currently only support large/small as values here.
376	Models map[SelectedModelType]SelectedModel `json:"models,omitempty" jsonschema:"description=Model configurations for different model types,example={\"large\":{\"model\":\"gpt-4o\",\"provider\":\"openai\"}}"`
377
378	// Recently used models stored in the data directory config.
379	RecentModels map[SelectedModelType][]SelectedModel `json:"recent_models,omitempty" jsonschema:"-"`
380
381	// The providers that are configured
382	Providers *csync.Map[string, ProviderConfig] `json:"providers,omitempty" jsonschema:"description=AI provider configurations"`
383
384	MCP MCPs `json:"mcp,omitempty" jsonschema:"description=Model Context Protocol server configurations"`
385
386	LSP LSPs `json:"lsp,omitempty" jsonschema:"description=Language Server Protocol configurations"`
387
388	Options *Options `json:"options,omitempty" jsonschema:"description=General application options"`
389
390	Permissions *Permissions `json:"permissions,omitempty" jsonschema:"description=Permission settings for tool usage"`
391
392	Tools Tools `json:"tools,omitzero" jsonschema:"description=Tool configurations"`
393
394	Agents map[string]Agent `json:"-"`
395}
396
397func (c *Config) EnabledProviders() []ProviderConfig {
398	var enabled []ProviderConfig
399	for p := range c.Providers.Seq() {
400		if !p.Disable {
401			enabled = append(enabled, p)
402		}
403	}
404	return enabled
405}
406
407// IsConfigured  return true if at least one provider is configured
408func (c *Config) IsConfigured() bool {
409	return len(c.EnabledProviders()) > 0
410}
411
412func (c *Config) GetModel(provider, model string) *catwalk.Model {
413	if providerConfig, ok := c.Providers.Get(provider); ok {
414		for _, m := range providerConfig.Models {
415			if m.ID == model {
416				return &m
417			}
418		}
419	}
420	return nil
421}
422
423func (c *Config) GetProviderForModel(modelType SelectedModelType) *ProviderConfig {
424	model, ok := c.Models[modelType]
425	if !ok {
426		return nil
427	}
428	if providerConfig, ok := c.Providers.Get(model.Provider); ok {
429		return &providerConfig
430	}
431	return nil
432}
433
434func (c *Config) GetModelByType(modelType SelectedModelType) *catwalk.Model {
435	model, ok := c.Models[modelType]
436	if !ok {
437		return nil
438	}
439	return c.GetModel(model.Provider, model.Model)
440}
441
442func (c *Config) LargeModel() *catwalk.Model {
443	model, ok := c.Models[SelectedModelTypeLarge]
444	if !ok {
445		return nil
446	}
447	return c.GetModel(model.Provider, model.Model)
448}
449
450func (c *Config) SmallModel() *catwalk.Model {
451	model, ok := c.Models[SelectedModelTypeSmall]
452	if !ok {
453		return nil
454	}
455	return c.GetModel(model.Provider, model.Model)
456}
457
458const maxRecentModelsPerType = 5
459
460func allToolNames() []string {
461	return []string{
462		"agent",
463		"bash",
464		"job_output",
465		"job_kill",
466		"download",
467		"edit",
468		"multiedit",
469		"lsp_diagnostics",
470		"lsp_references",
471		"lsp_restart",
472		"fetch",
473		"agentic_fetch",
474		"glob",
475		"grep",
476		"ls",
477		"sourcegraph",
478		"todos",
479		"view",
480		"write",
481		"list_mcp_resources",
482		"read_mcp_resource",
483	}
484}
485
486func resolveAllowedTools(allTools []string, disabledTools []string) []string {
487	if disabledTools == nil {
488		return allTools
489	}
490	// filter out disabled tools (exclude mode)
491	return filterSlice(allTools, disabledTools, false)
492}
493
494func resolveReadOnlyTools(tools []string) []string {
495	readOnlyTools := []string{"glob", "grep", "ls", "sourcegraph", "view"}
496	// filter to only include tools that are in allowedtools (include mode)
497	return filterSlice(tools, readOnlyTools, true)
498}
499
500func filterSlice(data []string, mask []string, include bool) []string {
501	var filtered []string
502	for _, s := range data {
503		// if include is true, we include items that ARE in the mask
504		// if include is false, we include items that are NOT in the mask
505		if include == slices.Contains(mask, s) {
506			filtered = append(filtered, s)
507		}
508	}
509	return filtered
510}
511
512func (c *Config) SetupAgents() {
513	allowedTools := resolveAllowedTools(allToolNames(), c.Options.DisabledTools)
514
515	agents := map[string]Agent{
516		AgentCoder: {
517			ID:           AgentCoder,
518			Name:         "Coder",
519			Description:  "An agent that helps with executing coding tasks.",
520			Model:        SelectedModelTypeLarge,
521			ContextPaths: c.Options.ContextPaths,
522			AllowedTools: allowedTools,
523		},
524
525		AgentTask: {
526			ID:           AgentTask,
527			Name:         "Task",
528			Description:  "An agent that helps with searching for context and finding implementation details.",
529			Model:        SelectedModelTypeLarge,
530			ContextPaths: c.Options.ContextPaths,
531			AllowedTools: resolveReadOnlyTools(allowedTools),
532			// NO MCPs or LSPs by default
533			AllowedMCP: map[string][]string{},
534		},
535	}
536	c.Agents = agents
537}
538
539func (c *ProviderConfig) TestConnection(resolver VariableResolver) error {
540	var (
541		providerID = catwalk.InferenceProvider(c.ID)
542		testURL    = ""
543		headers    = make(map[string]string)
544		apiKey, _  = resolver.ResolveValue(c.APIKey)
545	)
546
547	switch providerID {
548	case catwalk.InferenceProviderMiniMax, catwalk.InferenceProviderMiniMaxChina:
549		// NOTE: MiniMax has no good endpoint we can use to validate the API key.
550		// Let's at least check the pattern.
551		if !strings.HasPrefix(apiKey, "sk-") {
552			return fmt.Errorf("invalid API key format for provider %s", c.ID)
553		}
554		return nil
555	}
556
557	switch c.Type {
558	case catwalk.TypeOpenAI, catwalk.TypeOpenAICompat, catwalk.TypeOpenRouter:
559		baseURL, _ := resolver.ResolveValue(c.BaseURL)
560		baseURL = cmp.Or(baseURL, "https://api.openai.com/v1")
561
562		switch providerID {
563		case catwalk.InferenceProviderOpenRouter:
564			testURL = baseURL + "/credits"
565		default:
566			testURL = baseURL + "/models"
567		}
568
569		headers["Authorization"] = "Bearer " + apiKey
570	case catwalk.TypeAnthropic:
571		baseURL, _ := resolver.ResolveValue(c.BaseURL)
572		baseURL = cmp.Or(baseURL, "https://api.anthropic.com/v1")
573
574		switch providerID {
575		case catwalk.InferenceKimiCoding:
576			testURL = baseURL + "/v1/models"
577		default:
578			testURL = baseURL + "/models"
579		}
580
581		headers["x-api-key"] = apiKey
582		headers["anthropic-version"] = "2023-06-01"
583	case catwalk.TypeGoogle:
584		baseURL, _ := resolver.ResolveValue(c.BaseURL)
585		baseURL = cmp.Or(baseURL, "https://generativelanguage.googleapis.com")
586		testURL = baseURL + "/v1beta/models?key=" + url.QueryEscape(apiKey)
587	case catwalk.TypeBedrock:
588		// NOTE: Bedrock has a `/foundation-models` endpoint that we could in
589		// theory use, but apparently the authorization is region-specific,
590		// so it's not so trivial.
591		if strings.HasPrefix(apiKey, "ABSK") { // Bedrock API keys
592			return nil
593		}
594		return errors.New("not a valid bedrock api key")
595	case catwalk.TypeVercel:
596		// NOTE: Vercel does not validate API keys on the `/models` endpoint.
597		if strings.HasPrefix(apiKey, "vck_") { // Vercel API keys
598			return nil
599		}
600		return errors.New("not a valid vercel api key")
601	}
602
603	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
604	defer cancel()
605
606	client := &http.Client{}
607	req, err := http.NewRequestWithContext(ctx, "GET", testURL, nil)
608	if err != nil {
609		return fmt.Errorf("failed to create request for provider %s: %w", c.ID, err)
610	}
611	for k, v := range headers {
612		req.Header.Set(k, v)
613	}
614	for k, v := range c.ExtraHeaders {
615		req.Header.Set(k, v)
616	}
617
618	resp, err := client.Do(req)
619	if err != nil {
620		return fmt.Errorf("failed to create request for provider %s: %w", c.ID, err)
621	}
622	defer resp.Body.Close()
623
624	switch providerID {
625	case catwalk.InferenceProviderZAI:
626		if resp.StatusCode == http.StatusUnauthorized {
627			return fmt.Errorf("failed to connect to provider %s: %s", c.ID, resp.Status)
628		}
629	default:
630		if resp.StatusCode != http.StatusOK {
631			return fmt.Errorf("failed to connect to provider %s: %s", c.ID, resp.Status)
632		}
633	}
634	return nil
635}
636
637func resolveEnvs(envs map[string]string) []string {
638	resolver := NewShellVariableResolver(env.New())
639	for e, v := range envs {
640		var err error
641		envs[e], err = resolver.ResolveValue(v)
642		if err != nil {
643			slog.Error("Error resolving environment variable", "error", err, "variable", e, "value", v)
644			continue
645		}
646	}
647
648	res := make([]string, 0, len(envs))
649	for k, v := range envs {
650		res = append(res, fmt.Sprintf("%s=%s", k, v))
651	}
652	return res
653}
654
655func ptrValOr[T any](t *T, el T) T {
656	if t == nil {
657		return el
658	}
659	return *t
660}