git.iko.soy/crush
on main help sign in
crush/schema.json
866 lines 23 kB history raw
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 "providers": {
67 "additionalProperties": {
68 "$ref": "#/$defs/ProviderConfig"
69 },
70 "type": "object",
71 "description": "AI provider configurations"
72 },
73 "mcp": {
74 "$ref": "#/$defs/MCPs",
75 "description": "Model Context Protocol server configurations"
76 },
77 "lsp": {
78 "$ref": "#/$defs/LSPs",
79 "description": "Language Server Protocol configurations"
80 },
81 "options": {
82 "$ref": "#/$defs/Options",
83 "description": "General application options"
84 },
85 "permissions": {
86 "$ref": "#/$defs/Permissions",
87 "description": "Permission settings for tool usage"
88 },
89 "tools": {
90 "$ref": "#/$defs/Tools",
91 "description": "Tool configurations"
92 },
93 "hooks": {
94 "additionalProperties": {
95 "items": {
96 "$ref": "#/$defs/HookConfig"
97 },
98 "type": "array"
99 },
100 "type": "object",
101 "description": "User-defined shell commands that fire on hook events (e.g. PreToolUse)"
102 }
103 },
104 "additionalProperties": false,
105 "type": "object"
106 },
107 "HookConfig": {
108 "properties": {
109 "name": {
110 "type": "string",
111 "description": "Friendly display name shown in the TUI for this hook"
112 },
113 "matcher": {
114 "type": "string",
115 "description": "Regex pattern tested against the tool name. Empty means match all tools."
116 },
117 "command": {
118 "type": "string",
119 "description": "Shell command to execute when the hook fires"
120 },
121 "timeout": {
122 "type": "integer",
123 "description": "Timeout in seconds for the hook command",
124 "default": 30
125 }
126 },
127 "additionalProperties": false,
128 "type": "object",
129 "required": [
130 "command"
131 ]
132 },
133 "LSPConfig": {
134 "properties": {
135 "disabled": {
136 "type": "boolean",
137 "description": "Whether this LSP server is disabled",
138 "default": false
139 },
140 "command": {
141 "type": "string",
142 "description": "Command to execute for the LSP server",
143 "examples": [
144 "gopls"
145 ]
146 },
147 "args": {
148 "items": {
149 "type": "string"
150 },
151 "type": "array",
152 "description": "Arguments to pass to the LSP server command"
153 },
154 "env": {
155 "additionalProperties": {
156 "type": "string"
157 },
158 "type": "object",
159 "description": "Environment variables to set to the LSP server command"
160 },
161 "filetypes": {
162 "items": {
163 "type": "string",
164 "examples": [
165 "go",
166 "mod",
167 "rs",
168 "c",
169 "js",
170 "ts"
171 ]
172 },
173 "type": "array",
174 "description": "File types this LSP server handles"
175 },
176 "root_markers": {
177 "items": {
178 "type": "string",
179 "examples": [
180 "go.mod",
181 "package.json",
182 "Cargo.toml"
183 ]
184 },
185 "type": "array",
186 "description": "Files or directories that indicate the project root"
187 },
188 "init_options": {
189 "type": "object",
190 "description": "Initialization options passed to the LSP server during initialize request"
191 },
192 "options": {
193 "type": "object",
194 "description": "LSP server-specific settings passed during initialization"
195 },
196 "timeout": {
197 "type": "integer",
198 "description": "Timeout in seconds for LSP server initialization",
199 "default": 30,
200 "examples": [
201 60,
202 120
203 ]
204 }
205 },
206 "additionalProperties": false,
207 "type": "object"
208 },
209 "LSPs": {
210 "additionalProperties": {
211 "$ref": "#/$defs/LSPConfig"
212 },
213 "type": "object"
214 },
215 "MCPConfig": {
216 "properties": {
217 "command": {
218 "type": "string",
219 "description": "Command to execute for stdio MCP servers",
220 "examples": [
221 "npx"
222 ]
223 },
224 "env": {
225 "additionalProperties": {
226 "type": "string"
227 },
228 "type": "object",
229 "description": "Environment variables to set for the MCP server"
230 },
231 "args": {
232 "items": {
233 "type": "string"
234 },
235 "type": "array",
236 "description": "Arguments to pass to the MCP server command"
237 },
238 "type": {
239 "type": "string",
240 "enum": [
241 "stdio",
242 "sse",
243 "http"
244 ],
245 "description": "Type of MCP connection",
246 "default": "stdio"
247 },
248 "url": {
249 "type": "string",
250 "format": "uri",
251 "description": "URL for HTTP or SSE MCP servers",
252 "examples": [
253 "http://localhost:3000/mcp"
254 ]
255 },
256 "disabled": {
257 "type": "boolean",
258 "description": "Whether this MCP server is disabled",
259 "default": false
260 },
261 "disabled_tools": {
262 "items": {
263 "type": "string",
264 "examples": [
265 "get-library-doc"
266 ]
267 },
268 "type": "array",
269 "description": "List of tools from this MCP server to disable"
270 },
271 "enabled_tools": {
272 "items": {
273 "type": "string",
274 "examples": [
275 "get-library-doc"
276 ]
277 },
278 "type": "array",
279 "description": "Allow list of tools from this MCP server"
280 },
281 "timeout": {
282 "type": "integer",
283 "description": "Timeout in seconds for MCP server connections",
284 "default": 15,
285 "examples": [
286 30,
287 60,
288 120
289 ]
290 },
291 "headers": {
292 "additionalProperties": {
293 "type": "string"
294 },
295 "type": "object",
296 "description": "HTTP headers for HTTP/SSE MCP servers"
297 }
298 },
299 "additionalProperties": false,
300 "type": "object",
301 "required": [
302 "type"
303 ]
304 },
305 "MCPs": {
306 "additionalProperties": {
307 "$ref": "#/$defs/MCPConfig"
308 },
309 "type": "object"
310 },
311 "Model": {
312 "properties": {
313 "id": {
314 "type": "string"
315 },
316 "name": {
317 "type": "string"
318 },
319 "cost_per_1m_in": {
320 "type": "number"
321 },
322 "cost_per_1m_out": {
323 "type": "number"
324 },
325 "cost_per_1m_in_cached": {
326 "type": "number"
327 },
328 "cost_per_1m_out_cached": {
329 "type": "number"
330 },
331 "context_window": {
332 "type": "integer"
333 },
334 "default_max_tokens": {
335 "type": "integer"
336 },
337 "can_reason": {
338 "type": "boolean"
339 },
340 "reasoning_levels": {
341 "items": {
342 "type": "string"
343 },
344 "type": "array"
345 },
346 "default_reasoning_effort": {
347 "type": "string"
348 },
349 "supports_attachments": {
350 "type": "boolean"
351 },
352 "options": {
353 "$ref": "#/$defs/ModelOptions"
354 }
355 },
356 "additionalProperties": false,
357 "type": "object",
358 "required": [
359 "id",
360 "name",
361 "cost_per_1m_in",
362 "cost_per_1m_out",
363 "cost_per_1m_in_cached",
364 "cost_per_1m_out_cached",
365 "context_window",
366 "default_max_tokens",
367 "can_reason",
368 "supports_attachments"
369 ]
370 },
371 "ModelOptions": {
372 "properties": {
373 "temperature": {
374 "type": "number"
375 },
376 "top_p": {
377 "type": "number"
378 },
379 "top_k": {
380 "type": "integer"
381 },
382 "frequency_penalty": {
383 "type": "number"
384 },
385 "presence_penalty": {
386 "type": "number"
387 },
388 "provider_options": {
389 "type": "object"
390 }
391 },
392 "additionalProperties": false,
393 "type": "object"
394 },
395 "Options": {
396 "properties": {
397 "context_paths": {
398 "items": {
399 "type": "string",
400 "examples": [
401 ".cursorrules",
402 "CRUSH.md"
403 ]
404 },
405 "type": "array",
406 "description": "Paths to files containing context information for the AI"
407 },
408 "global_context_paths": {
409 "items": {
410 "type": "string"
411 },
412 "type": "array",
413 "description": "Paths to files containing global context information for the AI",
414 "default": [
415 "~/.config/crush/CRUSH.md",
416 "~/.config/AGENTS.md"
417 ]
418 },
419 "skills_paths": {
420 "items": {
421 "type": "string",
422 "examples": [
423 "~/.config/crush/skills",
424 "./skills"
425 ]
426 },
427 "type": "array",
428 "description": "Paths to directories containing Agent Skills (folders with SKILL.md files)"
429 },
430 "tui": {
431 "$ref": "#/$defs/TUIOptions",
432 "description": "Terminal user interface options"
433 },
434 "debug": {
435 "type": "boolean",
436 "description": "Enable debug logging",
437 "default": false
438 },
439 "debug_lsp": {
440 "type": "boolean",
441 "description": "Enable debug logging for LSP servers",
442 "default": false
443 },
444 "disable_auto_summarize": {
445 "type": "boolean",
446 "description": "Disable automatic conversation summarization",
447 "default": false
448 },
449 "data_directory": {
450 "type": "string",
451 "description": "Directory for storing application data. Relative paths are resolved against the working directory; absolute paths are used as-is.",
452 "default": ".crush",
453 "examples": [
454 ".crush"
455 ]
456 },
457 "disabled_tools": {
458 "items": {
459 "type": "string",
460 "examples": [
461 "bash",
462 "sourcegraph"
463 ]
464 },
465 "type": "array",
466 "description": "List of built-in tools to disable and hide from the agent"
467 },
468 "disable_provider_auto_update": {
469 "type": "boolean",
470 "description": "Disable providers auto-update",
471 "default": false
472 },
473 "disable_default_providers": {
474 "type": "boolean",
475 "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",
476 "default": false
477 },
478 "attribution": {
479 "$ref": "#/$defs/Attribution",
480 "description": "Attribution settings for generated content"
481 },
482 "disable_metrics": {
483 "type": "boolean",
484 "description": "Disable sending metrics",
485 "default": false
486 },
487 "initialize_as": {
488 "type": "string",
489 "description": "Name of the context file to create/update during project initialization",
490 "default": "AGENTS.md",
491 "examples": [
492 "AGENTS.md",
493 "CRUSH.md",
494 "CLAUDE.md",
495 "docs/LLMs.md"
496 ]
497 },
498 "auto_lsp": {
499 "type": "boolean",
500 "description": "Automatically setup LSPs based on root markers",
501 "default": true
502 },
503 "progress": {
504 "type": "boolean",
505 "description": "Show indeterminate progress updates during long operations",
506 "default": true
507 },
508 "disable_notifications": {
509 "type": "boolean",
510 "description": "Deprecated: Use notification_style instead. Disable desktop notifications",
511 "default": false
512 },
513 "notification_style": {
514 "type": "string",
515 "enum": [
516 "auto",
517 "native",
518 "osc",
519 "bell",
520 "disabled"
521 ],
522 "description": "Notification style to use. Options: auto (default)",
523 "default": "auto"
524 },
525 "disabled_skills": {
526 "items": {
527 "type": "string",
528 "examples": [
529 "crush-config"
530 ]
531 },
532 "type": "array",
533 "description": "List of skill names to disable and hide from the agent"
534 }
535 },
536 "additionalProperties": false,
537 "type": "object"
538 },
539 "Permissions": {
540 "properties": {
541 "allowed_tools": {
542 "items": {
543 "type": "string",
544 "examples": [
545 "bash",
546 "view"
547 ]
548 },
549 "type": "array",
550 "description": "List of tools that don't require permission prompts"
551 }
552 },
553 "additionalProperties": false,
554 "type": "object"
555 },
556 "ProviderConfig": {
557 "properties": {
558 "id": {
559 "type": "string",
560 "description": "Unique identifier for the provider",
561 "examples": [
562 "openai"
563 ]
564 },
565 "name": {
566 "type": "string",
567 "description": "Human-readable name for the provider",
568 "examples": [
569 "OpenAI"
570 ]
571 },
572 "base_url": {
573 "type": "string",
574 "format": "uri",
575 "description": "Base URL for the provider's API",
576 "examples": [
577 "https://api.openai.com/v1"
578 ]
579 },
580 "type": {
581 "type": "string",
582 "enum": [
583 "openai",
584 "openai-compat",
585 "openrouter",
586 "vercel",
587 "anthropic",
588 "google",
589 "azure",
590 "bedrock",
591 "google-vertex",
592 "hyper",
593 "litellm",
594 "llamacpp",
595 "lmstudio",
596 "ollama",
597 "omlx"
598 ],
599 "description": "Provider type that determines the API format",
600 "default": "openai"
601 },
602 "api_key": {
603 "type": "string",
604 "description": "API key for authentication with the provider",
605 "examples": [
606 "$OPENAI_API_KEY"
607 ]
608 },
609 "oauth": {
610 "$ref": "#/$defs/Token",
611 "description": "OAuth2 token for authentication with the provider"
612 },
613 "disable": {
614 "type": "boolean",
615 "description": "Whether this provider is disabled",
616 "default": false
617 },
618 "system_prompt_prefix": {
619 "type": "string",
620 "description": "Custom prefix to add to system prompts for this provider"
621 },
622 "extra_headers": {
623 "additionalProperties": {
624 "type": "string"
625 },
626 "type": "object",
627 "description": "Additional HTTP headers to send with requests"
628 },
629 "extra_body": {
630 "type": "object",
631 "description": "Additional fields to include in request bodies, only works with openai-compatible providers"
632 },
633 "provider_options": {
634 "type": "object",
635 "description": "Additional provider-specific options for this provider"
636 },
637 "flat_rate": {
638 "type": "boolean",
639 "description": "Flat-rate mode for this provider"
640 },
641 "discover_models": {
642 "type": "boolean",
643 "description": "Auto-discover models from /v1/models endpoint. When true with existing models they are merged (yours win)",
644 "default": true
645 },
646 "models": {
647 "items": {
648 "$ref": "#/$defs/Model"
649 },
650 "type": "array",
651 "description": "List of models available from this provider"
652 }
653 },
654 "additionalProperties": false,
655 "type": "object"
656 },
657 "SelectedModel": {
658 "properties": {
659 "model": {
660 "type": "string",
661 "description": "The model ID as used by the provider API",
662 "examples": [
663 "gpt-4o"
664 ]
665 },
666 "provider": {
667 "type": "string",
668 "description": "The model provider ID that matches a key in the providers config",
669 "examples": [
670 "openai"
671 ]
672 },
673 "reasoning_effort": {
674 "type": "string",
675 "enum": [
676 "low",
677 "medium",
678 "high"
679 ],
680 "description": "Reasoning effort level for OpenAI models that support it"
681 },
682 "think": {
683 "type": "boolean",
684 "description": "Enable thinking mode for Anthropic models that support reasoning"
685 },
686 "max_tokens": {
687 "type": "integer",
688 "maximum": 200000,
689 "description": "Maximum number of tokens for model responses",
690 "examples": [
691 4096
692 ]
693 },
694 "temperature": {
695 "type": "number",
696 "maximum": 1,
697 "minimum": 0,
698 "description": "Sampling temperature",
699 "examples": [
700 0.7
701 ]
702 },
703 "top_p": {
704 "type": "number",
705 "maximum": 1,
706 "minimum": 0,
707 "description": "Top-p (nucleus) sampling parameter",
708 "examples": [
709 0.9
710 ]
711 },
712 "top_k": {
713 "type": "integer",
714 "description": "Top-k sampling parameter"
715 },
716 "frequency_penalty": {
717 "type": "number",
718 "description": "Frequency penalty to reduce repetition"
719 },
720 "presence_penalty": {
721 "type": "number",
722 "description": "Presence penalty to increase topic diversity"
723 },
724 "provider_options": {
725 "type": "object",
726 "description": "Additional provider-specific options for the model"
727 }
728 },
729 "additionalProperties": false,
730 "type": "object",
731 "required": [
732 "model",
733 "provider"
734 ]
735 },
736 "TUIOptions": {
737 "properties": {
738 "compact_mode": {
739 "type": "boolean",
740 "description": "Enable compact mode for the TUI interface",
741 "default": false
742 },
743 "diff_mode": {
744 "type": "string",
745 "enum": [
746 "unified",
747 "split"
748 ],
749 "description": "Diff mode for the TUI interface"
750 },
751 "theme": {
752 "type": "string",
753 "enum": [
754 "auto",
755 "dark",
756 "light"
757 ],
758 "description": "TUI color scheme",
759 "default": "auto"
760 },
761 "completions": {
762 "$ref": "#/$defs/Completions",
763 "description": "Completions UI options"
764 },
765 "transparent": {
766 "type": "boolean",
767 "description": "Enable transparent background for the TUI interface",
768 "default": false
769 },
770 "scrollbar": {
771 "type": "string",
772 "enum": [
773 "default",
774 "always",
775 "never"
776 ],
777 "description": "Chat scrollbar visibility",
778 "default": "default"
779 }
780 },
781 "additionalProperties": false,
782 "type": "object"
783 },
784 "Token": {
785 "properties": {
786 "access_token": {
787 "type": "string"
788 },
789 "refresh_token": {
790 "type": "string"
791 },
792 "expires_in": {
793 "type": "integer"
794 },
795 "expires_at": {
796 "type": "integer"
797 }
798 },
799 "additionalProperties": false,
800 "type": "object",
801 "required": [
802 "access_token",
803 "refresh_token",
804 "expires_in",
805 "expires_at"
806 ]
807 },
808 "ToolGlob": {
809 "properties": {
810 "timeout": {
811 "type": "integer",
812 "description": "Timeout for the glob tool call"
813 }
814 },
815 "additionalProperties": false,
816 "type": "object"
817 },
818 "ToolGrep": {
819 "properties": {
820 "timeout": {
821 "type": "integer",
822 "description": "Timeout for the grep tool call"
823 }
824 },
825 "additionalProperties": false,
826 "type": "object"
827 },
828 "ToolLs": {
829 "properties": {
830 "max_depth": {
831 "type": "integer",
832 "description": "Maximum depth for the ls tool",
833 "default": 0,
834 "examples": [
835 10
836 ]
837 },
838 "max_items": {
839 "type": "integer",
840 "description": "Maximum number of items to return for the ls tool",
841 "default": 1000,
842 "examples": [
843 100
844 ]
845 }
846 },
847 "additionalProperties": false,
848 "type": "object"
849 },
850 "Tools": {
851 "properties": {
852 "ls": {
853 "$ref": "#/$defs/ToolLs"
854 },
855 "grep": {
856 "$ref": "#/$defs/ToolGrep"
857 },
858 "glob": {
859 "$ref": "#/$defs/ToolGlob"
860 }
861 },
862 "additionalProperties": false,
863 "type": "object"
864 }
865 }