1# Crush
2
3<p align="center">
4 <a href="https://stuff.charm.sh/crush/charm-crush.png"><img width="450" alt="Charm Crush Logo" src="https://github.com/user-attachments/assets/adc1a6f4-b284-4603-836c-59038caa2e8b" /></a><br />
5 <a href="https://github.com/charmbracelet/crush/releases"><img src="https://img.shields.io/github/release/charmbracelet/crush" alt="Latest Release"></a>
6 <a href="https://github.com/charmbracelet/crush/actions"><img src="https://github.com/charmbracelet/crush/actions/workflows/build.yml/badge.svg" alt="Build Status"></a>
7</p>
8
9<p align="center">Your new coding bestie, now available in your favourite terminal.<br />Your tools, your code, and your workflows, wired into your LLM of choice.</p>
10<p align="center">你的新编程伙伴，现在就在你最爱的终端中。<br />你的工具、代码和工作流，都与您选择的 LLM 模型紧密相连。</p>
11
12<p align="center"><img width="800" alt="Crush Demo" src="https://github.com/user-attachments/assets/58280caf-851b-470a-b6f7-d5c4ea8a1968" /></p>
13
14## Features
15
16- **Multi-Model:** choose from a wide range of LLMs or add your own via OpenAI- or Anthropic-compatible APIs
17- **Flexible:** switch LLMs mid-session while preserving context
18- **Session-Based:** maintain multiple work sessions and contexts per project
19- **LSP-Enhanced:** Crush uses LSPs for additional context, just like you do
20- **Extensible:** add capabilities via MCPs (`http`, `stdio`, and `sse`)
21- **Works Everywhere:** first-class support in every terminal on macOS, Linux, Windows (PowerShell and WSL), FreeBSD, OpenBSD, and NetBSD
22
23## Installation
24
25Use a package manager:
26
27```bash
28# Homebrew
29brew install charmbracelet/tap/crush
30
31# NPM
32npm install -g @charmland/crush
33
34# Arch Linux (btw)
35yay -S crush-bin
36
37# Nix
38nix run github:numtide/nix-ai-tools#crush
39```
40
41Windows users:
42
43```bash
44# Winget
45winget install charmbracelet.crush
46
47# Scoop
48scoop bucket add charm https://github.com/charmbracelet/scoop-bucket.git
49scoop install crush
50```
51
52<details>
53<summary><strong>Nix (NUR)</strong></summary>
54
55Crush is available via [NUR](https://github.com/nix-community/NUR) in `nur.repos.charmbracelet.crush`.
56
57You can also try out Crush via `nix-shell`:
58
59```bash
60# Add the NUR channel.
61nix-channel --add https://github.com/nix-community/NUR/archive/main.tar.gz nur
62nix-channel --update
63
64# Get Crush in a Nix shell.
65nix-shell -p '(import <nur> { pkgs = import <nixpkgs> {}; }).repos.charmbracelet.crush'
66```
67
68### NixOS & Home Manager Module Usage via NUR
69
70Crush provides NixOS and Home Manager modules via NUR.
71You can use these modules directly in your flake by importing them from NUR. Since it auto detects whether its a home manager or nixos context you can use the import the exact same way :)
72
73```nix
74{
75 inputs = {
76 nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
77 nur.url = "github:nix-community/NUR";
78 };
79
80 outputs = { self, nixpkgs, nur, ... }: {
81 nixosConfigurations.your-hostname = nixpkgs.lib.nixosSystem {
82 system = "x86_64-linux";
83 modules = [
84 nur.modules.nixos.default
85 nur.repos.charmbracelet.modules.crush
86 {
87 programs.crush = {
88 enable = true;
89 settings = {
90 providers = {
91 openai = {
92 id = "openai";
93 name = "OpenAI";
94 base_url = "https://api.openai.com/v1";
95 type = "openai";
96 api_key = "sk-fake123456789abcdef...";
97 models = [
98 {
99 id = "gpt-4";
100 name = "GPT-4";
101 }
102 ];
103 };
104 };
105 lsp = {
106 go = { command = "gopls"; enabled = true; };
107 nix = { command = "nil"; enabled = true; };
108 };
109 options = {
110 context_paths = [ "/etc/nixos/configuration.nix" ];
111 tui = { compact_mode = true; };
112 debug = false;
113 };
114 };
115 };
116 }
117 ];
118 };
119 };
120}
121```
122
123</details>
124
125<details>
126<summary><strong>Debian/Ubuntu</strong></summary>
127
128```bash
129sudo mkdir -p /etc/apt/keyrings
130curl -fsSL https://repo.charm.sh/apt/gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/charm.gpg
131echo "deb [signed-by=/etc/apt/keyrings/charm.gpg] https://repo.charm.sh/apt/ * *" | sudo tee /etc/apt/sources.list.d/charm.list
132sudo apt update && sudo apt install crush
133```
134
135</details>
136
137<details>
138<summary><strong>Fedora/RHEL</strong></summary>
139
140```bash
141echo '[charm]
142name=Charm
143baseurl=https://repo.charm.sh/yum/
144enabled=1
145gpgcheck=1
146gpgkey=https://repo.charm.sh/yum/gpg.key' | sudo tee /etc/yum.repos.d/charm.repo
147sudo yum install crush
148```
149
150</details>
151
152Or, download it:
153
154- [Packages][releases] are available in Debian and RPM formats
155- [Binaries][releases] are available for Linux, macOS, Windows, FreeBSD, OpenBSD, and NetBSD
156
157[releases]: https://github.com/charmbracelet/crush/releases
158
159Or just install it with Go:
160
161```
162go install github.com/charmbracelet/crush@latest
163```
164
165> [!WARNING]
166> Productivity may increase when using Crush and you may find yourself nerd
167> sniped when first using the application. If the symptoms persist, join the
168> [Discord][discord] and nerd snipe the rest of us.
169
170## Getting Started
171
172The quickest way to get started is to grab an API key for your preferred
173provider such as Anthropic, OpenAI, Groq, or OpenRouter and just start
174Crush. You'll be prompted to enter your API key.
175
176That said, you can also set environment variables for preferred providers.
177
178| Environment Variable | Provider |
179| --------------------------- | -------------------------------------------------- |
180| `ANTHROPIC_API_KEY` | Anthropic |
181| `OPENAI_API_KEY` | OpenAI |
182| `OPENROUTER_API_KEY` | OpenRouter |
183| `GEMINI_API_KEY` | Google Gemini |
184| `CEREBRAS_API_KEY` | Cerebras |
185| `HF_TOKEN` | Huggingface Inference |
186| `VERTEXAI_PROJECT` | Google Cloud VertexAI (Gemini) |
187| `VERTEXAI_LOCATION` | Google Cloud VertexAI (Gemini) |
188| `GROQ_API_KEY` | Groq |
189| `AWS_ACCESS_KEY_ID` | Amazon Bedrock (Claude) |
190| `AWS_SECRET_ACCESS_KEY` | Amazon Bedrock (Claude) |
191| `AWS_REGION` | Amazon Bedrock (Claude) |
192| `AWS_PROFILE` | Amazon Bedrock (Custom Profile) |
193| `AWS_BEARER_TOKEN_BEDROCK` | Amazon Bedrock |
194| `AZURE_OPENAI_API_ENDPOINT` | Azure OpenAI models |
195| `AZURE_OPENAI_API_KEY` | Azure OpenAI models (optional when using Entra ID) |
196| `AZURE_OPENAI_API_VERSION` | Azure OpenAI models |
197
198### By the Way
199
200Is there a provider you’d like to see in Crush? Is there an existing model that needs an update?
201
202Crush’s default model listing is managed in [Catwalk](https://github.com/charmbracelet/catwalk), a community-supported, open source repository of Crush-compatible models, and you’re welcome to contribute.
203
204<a href="https://github.com/charmbracelet/catwalk"><img width="174" height="174" alt="Catwalk Badge" src="https://github.com/user-attachments/assets/95b49515-fe82-4409-b10d-5beb0873787d" /></a>
205
206## Configuration
207
208Crush runs great with no configuration. That said, if you do need or want to
209customize Crush, configuration can be added either local to the project itself,
210or globally, with the following priority:
211
2121. `.crush.json`
2132. `crush.json`
2143. `$HOME/.config/crush/crush.json`
215
216Configuration itself is stored as a JSON object:
217
218```json
219{
220 "this-setting": { "this": "that" },
221 "that-setting": ["ceci", "cela"]
222}
223```
224
225As an additional note, Crush also stores ephemeral data, such as application state, in one additional location:
226
227```bash
228# Unix
229$HOME/.local/share/crush/crush.json
230
231# Windows
232%LOCALAPPDATA%\crush\crush.json
233```
234
235### LSPs
236
237Crush can use LSPs for additional context to help inform its decisions, just
238like you would. LSPs can be added manually like so:
239
240```json
241{
242 "$schema": "https://charm.land/crush.json",
243 "lsp": {
244 "go": {
245 "command": "gopls",
246 "env": {
247 "GOTOOLCHAIN": "go1.24.5"
248 }
249 },
250 "typescript": {
251 "command": "typescript-language-server",
252 "args": ["--stdio"]
253 },
254 "nix": {
255 "command": "nil"
256 }
257 }
258}
259```
260
261### MCPs
262
263Crush also supports Model Context Protocol (MCP) servers through three
264transport types: `stdio` for command-line servers, `http` for HTTP endpoints,
265and `sse` for Server-Sent Events. Environment variable expansion is supported
266using `$(echo $VAR)` syntax.
267
268```json
269{
270 "$schema": "https://charm.land/crush.json",
271 "mcp": {
272 "filesystem": {
273 "type": "stdio",
274 "command": "node",
275 "args": ["/path/to/mcp-server.js"],
276 "timeout": 120,
277 "disabled": false,
278 "disabled_tools": ["some-tool-name"],
279 "env": {
280 "NODE_ENV": "production"
281 }
282 },
283 "github": {
284 "type": "http",
285 "url": "https://api.githubcopilot.com/mcp/",
286 "timeout": 120,
287 "disabled": false,
288 "disabled_tools": ["create_issue", "create_pull_request"],
289 "headers": {
290 "Authorization": "Bearer $GH_PAT"
291 }
292 },
293 "streaming-service": {
294 "type": "sse",
295 "url": "https://example.com/mcp/sse",
296 "timeout": 120,
297 "disabled": false,
298 "headers": {
299 "API-Key": "$(echo $API_KEY)"
300 }
301 }
302 }
303}
304```
305
306### Memory
307
308Crush automatically includes two memory files for cross-project instructions.
309
310- `~/.config/crush/CRUSH.md`: Crush-specific rules that would confuse other
311 agentic coding tools. If you only use Crush, this is the only one you need to
312 edit.
313- `~/.config/AGENTS.md`: generic instructions that other coding tools might
314 read. Avoid referring to Crush-specific tools or workflows here.
315
316You can customize these paths using the `memory_paths` option in your
317configuration:
318
319```json
320{
321 "$schema": "https://charm.land/crush.json",
322 "options": {
323 "memory_paths": [
324 "/path/to/custom/memory/file.md",
325 "/path/to/folder/of/files/" // recursively load all .md files in folder
326 ]
327 }
328}
329```
330
331### Ignoring Files
332
333Crush respects `.gitignore` files by default, but you can also create a
334`.crushignore` file to specify additional files and directories that Crush
335should ignore. This is useful for excluding files that you want in version
336control but don't want Crush to consider when providing context.
337
338The `.crushignore` file uses the same syntax as `.gitignore` and can be placed
339in the root of your project or in subdirectories.
340
341### Allowing Tools
342
343By default, Crush will ask you for permission before running tool calls. If
344you'd like, you can allow tools to be executed without prompting you for
345permissions. Use this with care.
346
347```json
348{
349 "$schema": "https://charm.land/crush.json",
350 "permissions": {
351 "allowed_tools": [
352 "view",
353 "ls",
354 "grep",
355 "edit",
356 "mcp_context7_get-library-doc"
357 ]
358 }
359}
360```
361
362You can also skip all permission prompts entirely by running Crush with the
363`--yolo` flag. Be very, very careful with this feature.
364
365### Disabling Built-In Tools
366
367If you'd like to prevent Crush from using certain built-in tools entirely, you
368can disable them via the `options.disabled_tools` list. Disabled tools are
369completely hidden from the agent.
370
371```json
372{
373 "$schema": "https://charm.land/crush.json",
374 "options": {
375 "disabled_tools": [
376 "bash",
377 "sourcegraph"
378 ]
379 }
380}
381```
382
383To disable tools from MCP servers, see the [MCP config section](#mcps).
384
385### Desktop notifications
386
387Crush sends desktop notifications when a tool call requires permission and when
388the agent finishes its turn. They're only sent when the terminal window isn't
389focused _and_ your terminal supports reporting the focus state.
390
391```json
392{
393 "$schema": "https://charm.land/crush.json",
394 "options": {
395 "disable_notifications": true // default
396 }
397}
398```
399
400To disable desktop notifications, set `disable_notifications` to `true` in your
401configuration. On macOS, notifications currently lack icons due to platform
402limitations.
403
404### Initialization
405
406When you initialize a project, Crush analyzes your codebase and creates
407a context file that helps it work more effectively in future sessions.
408By default, this file is named `AGENTS.md`, but you can customize the
409name and location with the `initialize_as` option:
410
411```json
412{
413 "$schema": "https://charm.land/crush.json",
414 "options": {
415 "initialize_as": "AGENTS.md"
416 }
417}
418```
419
420This is useful if you prefer a different naming convention or want to
421place the file in a specific directory (e.g., `CRUSH.md` or
422`docs/LLMs.md`). Crush will fill the file with project-specific context
423like build commands, code patterns, and conventions it discovered during
424initialization.
425
426### Attribution Settings
427
428By default, Crush adds attribution information to Git commits and pull requests
429it creates. You can customize this behavior with the `attribution` option:
430
431```json
432{
433 "$schema": "https://charm.land/crush.json",
434 "options": {
435 "attribution": {
436 "trailer_style": "co-authored-by",
437 "generated_with": true
438 }
439 }
440}
441```
442
443- `trailer_style`: Controls the attribution trailer added to commit messages
444 (default: `assisted-by`)
445 - `assisted-by`: Adds `Assisted-by: [Model Name] via Crush <crush@charm.land>`
446 (includes the model name)
447 - `co-authored-by`: Adds `Co-Authored-By: Crush <crush@charm.land>`
448 - `none`: No attribution trailer
449- `generated_with`: When true (default), adds `💘 Generated with Crush` line to
450 commit messages and PR descriptions
451
452### Custom Providers
453
454Crush supports custom provider configurations for both OpenAI-compatible and
455Anthropic-compatible APIs.
456
457> [!NOTE]
458> Note that we support two "types" for OpenAI. Make sure to choose the right one
459> to ensure the best experience!
460> * `openai` should be used when proxying or routing requests through OpenAI.
461> * `openai-compat` should be used when using non-OpenAI providers that have OpenAI-compatible APIs.
462
463#### OpenAI-Compatible APIs
464
465Here’s an example configuration for Deepseek, which uses an OpenAI-compatible
466API. Don't forget to set `DEEPSEEK_API_KEY` in your environment.
467
468```json
469{
470 "$schema": "https://charm.land/crush.json",
471 "providers": {
472 "deepseek": {
473 "type": "openai-compat",
474 "base_url": "https://api.deepseek.com/v1",
475 "api_key": "$DEEPSEEK_API_KEY",
476 "models": [
477 {
478 "id": "deepseek-chat",
479 "name": "Deepseek V3",
480 "cost_per_1m_in": 0.27,
481 "cost_per_1m_out": 1.1,
482 "cost_per_1m_in_cached": 0.07,
483 "cost_per_1m_out_cached": 1.1,
484 "context_window": 64000,
485 "default_max_tokens": 5000
486 }
487 ]
488 }
489 }
490}
491```
492
493#### Anthropic-Compatible APIs
494
495Custom Anthropic-compatible providers follow this format:
496
497```json
498{
499 "$schema": "https://charm.land/crush.json",
500 "providers": {
501 "custom-anthropic": {
502 "type": "anthropic",
503 "base_url": "https://api.anthropic.com/v1",
504 "api_key": "$ANTHROPIC_API_KEY",
505 "extra_headers": {
506 "anthropic-version": "2023-06-01"
507 },
508 "models": [
509 {
510 "id": "claude-sonnet-4-20250514",
511 "name": "Claude Sonnet 4",
512 "cost_per_1m_in": 3,
513 "cost_per_1m_out": 15,
514 "cost_per_1m_in_cached": 3.75,
515 "cost_per_1m_out_cached": 0.3,
516 "context_window": 200000,
517 "default_max_tokens": 50000,
518 "can_reason": true,
519 "supports_attachments": true
520 }
521 ]
522 }
523 }
524}
525```
526
527### Amazon Bedrock
528
529Crush currently supports running Anthropic models through Bedrock, with caching disabled.
530
531- A Bedrock provider will appear once you have AWS configured, i.e. `aws configure`
532- Crush also expects the `AWS_REGION` or `AWS_DEFAULT_REGION` to be set
533- To use a specific AWS profile set `AWS_PROFILE` in your environment, i.e. `AWS_PROFILE=myprofile crush`
534- Alternatively to `aws configure`, you can also just set `AWS_BEARER_TOKEN_BEDROCK`
535
536### Vertex AI Platform
537
538Vertex AI will appear in the list of available providers when `VERTEXAI_PROJECT` and `VERTEXAI_LOCATION` are set. You will also need to be authenticated:
539
540```bash
541gcloud auth application-default login
542```
543
544To add specific models to the configuration, configure as such:
545
546```json
547{
548 "$schema": "https://charm.land/crush.json",
549 "providers": {
550 "vertexai": {
551 "models": [
552 {
553 "id": "claude-sonnet-4@20250514",
554 "name": "VertexAI Sonnet 4",
555 "cost_per_1m_in": 3,
556 "cost_per_1m_out": 15,
557 "cost_per_1m_in_cached": 3.75,
558 "cost_per_1m_out_cached": 0.3,
559 "context_window": 200000,
560 "default_max_tokens": 50000,
561 "can_reason": true,
562 "supports_attachments": true
563 }
564 ]
565 }
566 }
567}
568```
569
570### Local Models
571
572Local models can also be configured via OpenAI-compatible API. Here are two common examples:
573
574#### Ollama
575
576```json
577{
578 "providers": {
579 "ollama": {
580 "name": "Ollama",
581 "base_url": "http://localhost:11434/v1/",
582 "type": "openai-compat",
583 "models": [
584 {
585 "name": "Qwen 3 30B",
586 "id": "qwen3:30b",
587 "context_window": 256000,
588 "default_max_tokens": 20000
589 }
590 ]
591 }
592 }
593}
594```
595
596#### LM Studio
597
598```json
599{
600 "providers": {
601 "lmstudio": {
602 "name": "LM Studio",
603 "base_url": "http://localhost:1234/v1/",
604 "type": "openai-compat",
605 "models": [
606 {
607 "name": "Qwen 3 30B",
608 "id": "qwen/qwen3-30b-a3b-2507",
609 "context_window": 256000,
610 "default_max_tokens": 20000
611 }
612 ]
613 }
614 }
615}
616```
617
618## Logging
619
620Sometimes you need to look at logs. Luckily, Crush logs all sorts of
621stuff. Logs are stored in `./.crush/logs/crush.log` relative to the project.
622
623The CLI also contains some helper commands to make perusing recent logs easier:
624
625```bash
626# Print the last 1000 lines
627crush logs
628
629# Print the last 500 lines
630crush logs --tail 500
631
632# Follow logs in real time
633crush logs --follow
634```
635
636Want more logging? Run `crush` with the `--debug` flag, or enable it in the
637config:
638
639```json
640{
641 "$schema": "https://charm.land/crush.json",
642 "options": {
643 "debug": true,
644 "debug_lsp": true
645 }
646}
647```
648
649## Provider Auto-Updates
650
651By default, Crush automatically checks for the latest and greatest list of
652providers and models from [Catwalk](https://github.com/charmbracelet/catwalk),
653the open source Crush provider database. This means that when new providers and
654models are available, or when model metadata changes, Crush automatically
655updates your local configuration.
656
657### Disabling automatic provider updates
658
659For those with restricted internet access, or those who prefer to work in
660air-gapped environments, this might not be want you want, and this feature can
661be disabled.
662
663To disable automatic provider updates, set `disable_provider_auto_update` into
664your `crush.json` config:
665
666```json
667{
668 "$schema": "https://charm.land/crush.json",
669 "options": {
670 "disable_provider_auto_update": true
671 }
672}
673```
674
675Or set the `CRUSH_DISABLE_PROVIDER_AUTO_UPDATE` environment variable:
676
677```bash
678export CRUSH_DISABLE_PROVIDER_AUTO_UPDATE=1
679```
680
681### Manually updating providers
682
683Manually updating providers is possible with the `crush update-providers`
684command:
685
686```bash
687# Update providers remotely from Catwalk.
688crush update-providers
689
690# Update providers from a custom Catwalk base URL.
691crush update-providers https://example.com/
692
693# Update providers from a local file.
694crush update-providers /path/to/local-providers.json
695
696# Reset providers to the embedded version, embedded at crush at build time.
697crush update-providers embedded
698
699# For more info:
700crush update-providers --help
701```
702
703## Metrics
704
705Crush records pseudonymous usage metrics (tied to a device-specific hash),
706which maintainers rely on to inform development and support priorities. The
707metrics include solely usage metadata; prompts and responses are NEVER
708collected.
709
710Details on exactly what’s collected are in the source code ([here](https://github.com/charmbracelet/crush/tree/main/internal/event)
711and [here](https://github.com/charmbracelet/crush/blob/main/internal/llm/agent/event.go)).
712
713You can opt out of metrics collection at any time by setting the environment
714variable by setting the following in your environment:
715
716```bash
717export CRUSH_DISABLE_METRICS=1
718```
719
720Or by setting the following in your config:
721
722```json
723{
724 "options": {
725 "disable_metrics": true
726 }
727}
728```
729
730Crush also respects the [`DO_NOT_TRACK`](https://consoledonottrack.com)
731convention which can be enabled via `export DO_NOT_TRACK=1`.
732
733## Contributing
734
735See the [contributing guide](https://github.com/charmbracelet/crush?tab=contributing-ov-file#contributing).
736
737## Whatcha think?
738
739We’d love to hear your thoughts on this project. Need help? We gotchu. You can find us on:
740
741- [Twitter](https://twitter.com/charmcli)
742- [Slack](https://charm.land/slack)
743- [Discord][discord]
744- [The Fediverse](https://mastodon.social/@charmcli)
745- [Bluesky](https://bsky.app/profile/charm.land)
746
747[discord]: https://charm.land/discord
748
749## License
750
751[FSL-1.1-MIT](https://github.com/charmbracelet/crush/raw/main/LICENSE.md)
752
753---
754
755Part of [Charm](https://charm.land).
756
757<a href="https://charm.land/"><img alt="The Charm logo" width="400" src="https://stuff.charm.sh/charm-banner-next.jpg" /></a>
758
759<!--prettier-ignore-->
760Charm热爱开源 • Charm loves open source