crush-config
Use when the user needs help configuring Crush — working with crush.json, setting up providers, configuring LSPs, adding MCP servers, managing skills or permissions, or changing Crush behavior.
Best for Project teams needing consi…Works with GitHubLow risk
⌘source
- author
@charmbracelet- language
- Go
★23kstars
1.5kforks
Apr 21, 2026
✦overview.md
Key Features
- ·Configure Crush via JSON files with priority hierarchy
- ·Add custom providers with type, baseurl, apikey, and models
- ·Disable builtin or local skills in options.disabledskills
- ·Add MCP servers with type and command/url
- ·Define model configurations with required model and provider fields
- ·Optional $schema property for IDE autocomplete
Use Cases
- →Setting up custom AI providers for Crush in a project
- →Disabling specific skills that aren't needed for a particular workflow
- →Adding MCP servers to extend Crush's capabilities
- →Configuring different models for different tasks (large for coding, small for summarization)
- →Managing project-specific Crush settings separate from global configuration
Best for
- ✓Project teams needing consistent Crush configuration
- ✓Developers customizing their Crush setup
Not ideal for
- !Users wanting GUI configuration
- !One-time configuration changes
FAQs
name
crush-config
description
Use when the user needs help configuring Crush — working with crush.json, setting up providers, configuring LSPs, adding MCP servers, managing skills or permissions, or changing Crush behavior.
Crush Configuration
Crush uses JSON configuration files with the following priority (highest to lowest):
.crush.json(project-local, hidden)crush.json(project-local)$XDG_CONFIG_HOME/crush/crush.jsonor$HOME/.config/crush/crush.json(global)
Basic Structure
{
"$schema": "https://charm.land/crush.json",
"models": {},
"providers": {},
"mcp": {},
"lsp": {},
"options": {},
"permissions": {},
"tools": {}
}
The $schema property enables IDE autocomplete but is optional.
Common Tasks
- Add a custom provider: add an entry under
providerswithtype,base_url,api_key, andmodels. - Disable a builtin or local skill: add the skill name to
options.disabled_skills. - Add an MCP server: add an entry under
mcpwithtypeand eithercommand(stdio) orurl(http/sse).
Model Selection
{
"models": {
"large": {
"model": "claude-sonnet-4-20250514",
"provider": "anthropic",
"max_tokens": 16384
},
"small": {
"model": "claude-haiku-4-20250514",
"provider": "anthropic"
}
}
}
largeis the primary coding model;smallis for summarization.
$install
1-click copynpx skills add charmbracelet/crush --skill crush-configSafety assessment
★
Clarity score
How clear and easy to understand the SKILL.md instructions are, rated from 1 to 5.
4/ 5
very goodClear and well structured, with only minor parts that might need a second read.
◎
Actionability score
How directly an agent can act on the SKILL.md instructions, rated from 1 to 5.
3/ 5
mediumPartially actionable with several concrete steps, but still missing important details.