1{
2 "$schema": "https://json-schema.org/draft/2020-12/schema",
3 "$id": "https://github.com/charmbracelet/crush/internal/config/config",
4 "$ref": "#/$defs/Config",
5 "$defs": {
6 "Attribution": {
7 "properties": {
8 "trailer_style": {
9 "type": "string",
10 "enum": [
11 "none",
12 "co-authored-by",
13 "assisted-by"
14 ],
15 "description": "Style of attribution trailer to add to commits",
16 "default": "assisted-by"
17 },
18 "co_authored_by": {
19 "type": "boolean",
20 "description": "Deprecated: use trailer_style instead",
21 "deprecated": true
22 },
23 "generated_with": {
24 "type": "boolean",
25 "description": "Add Generated with Crush line to commit messages and issues and PRs",
26 "default": true
27 }
28 },
29 "additionalProperties": false,
30 "type": "object"
31 },
32 "Completions": {
33 "properties": {
34 "max_depth": {
35 "type": "integer",
36 "description": "Maximum depth for the ls tool",
37 "default": 0,
38 "examples": [
39 10
40 ]
41 },
42 "max_items": {
43 "type": "integer",
44 "description": "Maximum number of items to return for the ls tool",
45 "default": 1000,
46 "examples": [
47 100
48 ]
49 }
50 },
51 "additionalProperties": false,
52 "type": "object"
53 },
54 "Config": {
55 "properties": {
56 "$schema": {
57 "type": "string"
58 },
59 "models": {
60 "additionalProperties": {
61 "$ref": "#/$defs/SelectedModel"
62 },
63 "type": "object",
64 "description": "Model configurations for different model types"
65 },
66 "recent_models": {
67 "additionalProperties": {
68 "items": {
69 "$ref": "#/$defs/SelectedModel"
70 },
71 "type": "array"
72 },
73 "type": "object",
74 "description": "Recently used models sorted by most recent first"
75 },
76 "providers": {
77 "additionalProperties": {
78 "$ref": "#/$defs/ProviderConfig"
79 },
80 "type": "object",
81 "description": "AI provider configurations"
82 },
83 "mcp": {
84 "$ref": "#/$defs/MCPs",
85 "description": "Model Context Protocol server configurations"
86 },
87 "lsp": {
88 "$ref": "#/$defs/LSPs",
89 "description": "Language Server Protocol configurations"
90 },
91 "options": {
92 "$ref": "#/$defs/Options",
93 "description": "General application options"
94 },
95 "permissions": {
96 "$ref": "#/$defs/Permissions",
97 "description": "Permission settings for tool usage"
98 },
99 "tools": {
100 "$ref": "#/$defs/Tools",
101 "description": "Tool configurations"
102 }
103 },
104 "additionalProperties": false,
105 "type": "object",
106 "required": [
107 "tools"
108 ]
109 },
110 "LSPConfig": {
111 "properties": {
112 "disabled": {
113 "type": "boolean",
114 "description": "Whether this LSP server is disabled",
115 "default": false
116 },
117 "command": {
118 "type": "string",
119 "description": "Command to execute for the LSP server",
120 "examples": [
121 "gopls"
122 ]
123 },
124 "args": {
125 "items": {
126 "type": "string"
127 },
128 "type": "array",
129 "description": "Arguments to pass to the LSP server command"
130 },
131 "env": {
132 "additionalProperties": {
133 "type": "string"
134 },
135 "type": "object",
136 "description": "Environment variables to set to the LSP server command"
137 },
138 "filetypes": {
139 "items": {
140 "type": "string",
141 "examples": [
142 "go",
143 "mod",
144 "rs",
145 "c",
146 "js",
147 "ts"
148 ]
149 },
150 "type": "array",
151 "description": "File types this LSP server handles"
152 },
153 "root_markers": {
154 "items": {
155 "type": "string",
156 "examples": [
157 "go.mod",
158 "package.json",
159 "Cargo.toml"
160 ]
161 },
162 "type": "array",
163 "description": "Files or directories that indicate the project root"
164 },
165 "init_options": {
166 "type": "object",
167 "description": "Initialization options passed to the LSP server during initialize request"
168 },
169 "options": {
170 "type": "object",
171 "description": "LSP server-specific settings passed during initialization"
172 }
173 },
174 "additionalProperties": false,
175 "type": "object",
176 "required": [
177 "command"
178 ]
179 },
180 "LSPs": {
181 "additionalProperties": {
182 "$ref": "#/$defs/LSPConfig"
183 },
184 "type": "object"
185 },
186 "MCPConfig": {
187 "properties": {
188 "command": {
189 "type": "string",
190 "description": "Command to execute for stdio MCP servers",
191 "examples": [
192 "npx"
193 ]
194 },
195 "env": {
196 "additionalProperties": {
197 "type": "string"
198 },
199 "type": "object",
200 "description": "Environment variables to set for the MCP server"
201 },
202 "args": {
203 "items": {
204 "type": "string"
205 },
206 "type": "array",
207 "description": "Arguments to pass to the MCP server command"
208 },
209 "type": {
210 "type": "string",
211 "enum": [
212 "stdio",
213 "sse",
214 "http"
215 ],
216 "description": "Type of MCP connection",
217 "default": "stdio"
218 },
219 "url": {
220 "type": "string",
221 "format": "uri",
222 "description": "URL for HTTP or SSE MCP servers",
223 "examples": [
224 "http://localhost:3000/mcp"
225 ]
226 },
227 "disabled": {
228 "type": "boolean",
229 "description": "Whether this MCP server is disabled",
230 "default": false
231 },
232 "timeout": {
233 "type": "integer",
234 "description": "Timeout in seconds for MCP server connections",
235 "default": 15,
236 "examples": [
237 30,
238 60,
239 120
240 ]
241 },
242 "headers": {
243 "additionalProperties": {
244 "type": "string"
245 },
246 "type": "object",
247 "description": "HTTP headers for HTTP/SSE MCP servers"
248 }
249 },
250 "additionalProperties": false,
251 "type": "object",
252 "required": [
253 "type"
254 ]
255 },
256 "MCPs": {
257 "additionalProperties": {
258 "$ref": "#/$defs/MCPConfig"
259 },
260 "type": "object"
261 },
262 "Model": {
263 "properties": {
264 "id": {
265 "type": "string"
266 },
267 "name": {
268 "type": "string"
269 },
270 "cost_per_1m_in": {
271 "type": "number"
272 },
273 "cost_per_1m_out": {
274 "type": "number"
275 },
276 "cost_per_1m_in_cached": {
277 "type": "number"
278 },
279 "cost_per_1m_out_cached": {
280 "type": "number"
281 },
282 "context_window": {
283 "type": "integer"
284 },
285 "default_max_tokens": {
286 "type": "integer"
287 },
288 "can_reason": {
289 "type": "boolean"
290 },
291 "reasoning_levels": {
292 "items": {
293 "type": "string"
294 },
295 "type": "array"
296 },
297 "default_reasoning_effort": {
298 "type": "string"
299 },
300 "supports_attachments": {
301 "type": "boolean"
302 },
303 "options": {
304 "$ref": "#/$defs/ModelOptions"
305 }
306 },
307 "additionalProperties": false,
308 "type": "object",
309 "required": [
310 "id",
311 "name",
312 "cost_per_1m_in",
313 "cost_per_1m_out",
314 "cost_per_1m_in_cached",
315 "cost_per_1m_out_cached",
316 "context_window",
317 "default_max_tokens",
318 "can_reason",
319 "supports_attachments",
320 "options"
321 ]
322 },
323 "ModelOptions": {
324 "properties": {
325 "temperature": {
326 "type": "number"
327 },
328 "top_p": {
329 "type": "number"
330 },
331 "top_k": {
332 "type": "integer"
333 },
334 "frequency_penalty": {
335 "type": "number"
336 },
337 "presence_penalty": {
338 "type": "number"
339 },
340 "provider_options": {
341 "type": "object"
342 }
343 },
344 "additionalProperties": false,
345 "type": "object"
346 },
347 "Options": {
348 "properties": {
349 "context_paths": {
350 "items": {
351 "type": "string",
352 "examples": [
353 ".cursorrules",
354 "CRUSH.md"
355 ]
356 },
357 "type": "array",
358 "description": "Paths to files containing context information for the AI"
359 },
360 "memory_paths": {
361 "items": {
362 "type": "string"
363 },
364 "type": "array",
365 "description": "Paths to files containing memory information for the AI",
366 "default": [
367 "~/.config/crush/CRUSH.md",
368 "~/.config/AGENTS.md"
369 ]
370 },
371 "tui": {
372 "$ref": "#/$defs/TUIOptions",
373 "description": "Terminal user interface options"
374 },
375 "debug": {
376 "type": "boolean",
377 "description": "Enable debug logging",
378 "default": false
379 },
380 "debug_lsp": {
381 "type": "boolean",
382 "description": "Enable debug logging for LSP servers",
383 "default": false
384 },
385 "disable_auto_summarize": {
386 "type": "boolean",
387 "description": "Disable automatic conversation summarization",
388 "default": false
389 },
390 "data_directory": {
391 "type": "string",
392 "description": "Directory for storing application data (relative to working directory)",
393 "default": ".crush",
394 "examples": [
395 ".crush"
396 ]
397 },
398 "disabled_tools": {
399 "items": {
400 "type": "string"
401 },
402 "type": "array",
403 "description": "Tools to disable"
404 },
405 "disable_provider_auto_update": {
406 "type": "boolean",
407 "description": "Disable providers auto-update",
408 "default": false
409 },
410 "attribution": {
411 "$ref": "#/$defs/Attribution",
412 "description": "Attribution settings for generated content"
413 },
414 "disable_metrics": {
415 "type": "boolean",
416 "description": "Disable sending metrics",
417 "default": false
418 },
419 "initialize_as": {
420 "type": "string",
421 "description": "Name of the context file to create/update during project initialization",
422 "default": "AGENTS.md",
423 "examples": [
424 "AGENTS.md",
425 "CRUSH.md",
426 "CLAUDE.md",
427 "docs/LLMs.md"
428 ]
429 }
430 },
431 "additionalProperties": false,
432 "type": "object",
433 "required": [
434 "disabled_tools"
435 ]
436 },
437 "Permissions": {
438 "properties": {
439 "allowed_tools": {
440 "items": {
441 "type": "string",
442 "examples": [
443 "bash",
444 "view"
445 ]
446 },
447 "type": "array",
448 "description": "List of tools that don't require permission prompts"
449 }
450 },
451 "additionalProperties": false,
452 "type": "object"
453 },
454 "ProviderConfig": {
455 "properties": {
456 "id": {
457 "type": "string",
458 "description": "Unique identifier for the provider",
459 "examples": [
460 "openai"
461 ]
462 },
463 "name": {
464 "type": "string",
465 "description": "Human-readable name for the provider",
466 "examples": [
467 "OpenAI"
468 ]
469 },
470 "base_url": {
471 "type": "string",
472 "format": "uri",
473 "description": "Base URL for the provider's API",
474 "examples": [
475 "https://api.openai.com/v1"
476 ]
477 },
478 "type": {
479 "type": "string",
480 "enum": [
481 "openai",
482 "openai-compat",
483 "anthropic",
484 "gemini",
485 "azure",
486 "vertexai"
487 ],
488 "description": "Provider type that determines the API format",
489 "default": "openai"
490 },
491 "api_key": {
492 "type": "string",
493 "description": "API key for authentication with the provider",
494 "examples": [
495 "$OPENAI_API_KEY"
496 ]
497 },
498 "oauth": {
499 "$ref": "#/$defs/Token",
500 "description": "OAuth2 token for authentication with the provider"
501 },
502 "disable": {
503 "type": "boolean",
504 "description": "Whether this provider is disabled",
505 "default": false
506 },
507 "system_prompt_prefix": {
508 "type": "string",
509 "description": "Custom prefix to add to system prompts for this provider"
510 },
511 "extra_headers": {
512 "additionalProperties": {
513 "type": "string"
514 },
515 "type": "object",
516 "description": "Additional HTTP headers to send with requests"
517 },
518 "extra_body": {
519 "type": "object",
520 "description": "Additional fields to include in request bodies"
521 },
522 "provider_options": {
523 "type": "object",
524 "description": "Additional provider-specific options for this provider"
525 },
526 "models": {
527 "items": {
528 "$ref": "#/$defs/Model"
529 },
530 "type": "array",
531 "description": "List of models available from this provider"
532 }
533 },
534 "additionalProperties": false,
535 "type": "object"
536 },
537 "SelectedModel": {
538 "properties": {
539 "model": {
540 "type": "string",
541 "description": "The model ID as used by the provider API",
542 "examples": [
543 "gpt-4o"
544 ]
545 },
546 "provider": {
547 "type": "string",
548 "description": "The model provider ID that matches a key in the providers config",
549 "examples": [
550 "openai"
551 ]
552 },
553 "reasoning_effort": {
554 "type": "string",
555 "enum": [
556 "low",
557 "medium",
558 "high"
559 ],
560 "description": "Reasoning effort level for OpenAI models that support it"
561 },
562 "think": {
563 "type": "boolean",
564 "description": "Enable thinking mode for Anthropic models that support reasoning"
565 },
566 "max_tokens": {
567 "type": "integer",
568 "maximum": 200000,
569 "minimum": 1,
570 "description": "Maximum number of tokens for model responses",
571 "examples": [
572 4096
573 ]
574 },
575 "temperature": {
576 "type": "number",
577 "maximum": 1,
578 "minimum": 0,
579 "description": "Sampling temperature",
580 "examples": [
581 0.7
582 ]
583 },
584 "top_p": {
585 "type": "number",
586 "maximum": 1,
587 "minimum": 0,
588 "description": "Top-p (nucleus) sampling parameter",
589 "examples": [
590 0.9
591 ]
592 },
593 "top_k": {
594 "type": "integer",
595 "description": "Top-k sampling parameter"
596 },
597 "frequency_penalty": {
598 "type": "number",
599 "description": "Frequency penalty to reduce repetition"
600 },
601 "presence_penalty": {
602 "type": "number",
603 "description": "Presence penalty to increase topic diversity"
604 },
605 "provider_options": {
606 "type": "object",
607 "description": "Additional provider-specific options for the model"
608 }
609 },
610 "additionalProperties": false,
611 "type": "object",
612 "required": [
613 "model",
614 "provider"
615 ]
616 },
617 "TUIOptions": {
618 "properties": {
619 "compact_mode": {
620 "type": "boolean",
621 "description": "Enable compact mode for the TUI interface",
622 "default": false
623 },
624 "diff_mode": {
625 "type": "string",
626 "enum": [
627 "unified",
628 "split"
629 ],
630 "description": "Diff mode for the TUI interface"
631 },
632 "completions": {
633 "$ref": "#/$defs/Completions",
634 "description": "Completions UI options"
635 }
636 },
637 "additionalProperties": false,
638 "type": "object",
639 "required": [
640 "completions"
641 ]
642 },
643 "Token": {
644 "properties": {
645 "access_token": {
646 "type": "string"
647 },
648 "refresh_token": {
649 "type": "string"
650 },
651 "expires_in": {
652 "type": "integer"
653 },
654 "expires_at": {
655 "type": "integer"
656 }
657 },
658 "additionalProperties": false,
659 "type": "object",
660 "required": [
661 "access_token",
662 "refresh_token",
663 "expires_in",
664 "expires_at"
665 ]
666 },
667 "ToolLs": {
668 "properties": {
669 "max_depth": {
670 "type": "integer",
671 "description": "Maximum depth for the ls tool",
672 "default": 0,
673 "examples": [
674 10
675 ]
676 },
677 "max_items": {
678 "type": "integer",
679 "description": "Maximum number of items to return for the ls tool",
680 "default": 1000,
681 "examples": [
682 100
683 ]
684 }
685 },
686 "additionalProperties": false,
687 "type": "object"
688 },
689 "Tools": {
690 "properties": {
691 "ls": {
692 "$ref": "#/$defs/ToolLs"
693 }
694 },
695 "additionalProperties": false,
696 "type": "object",
697 "required": [
698 "ls"
699 ]
700 }
701 }
702}