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 "env": {
279 "NODE_ENV": "production"
280 }
281 },
282 "github": {
283 "type": "http",
284 "url": "https://api.githubcopilot.com/mcp/",
285 "timeout": 120,
286 "disabled": false,
287 "headers": {
288 "Authorization": "Bearer $GH_PAT"
289 }
290 },
291 "streaming-service": {
292 "type": "sse",
293 "url": "https://example.com/mcp/sse",
294 "timeout": 120,
295 "disabled": false,
296 "headers": {
297 "API-Key": "$(echo $API_KEY)"
298 }
299 }
300 }
301}
302```
303
304### Memory
305
306Crush automatically includes two memory files for cross-project instructions.
307
308- `~/.config/crush/CRUSH.md`: Crush-specific rules that would confuse other
309 agentic coding tools. If you only use Crush, this is the only one you need to
310 edit.
311- `~/.config/AGENTS.md`: generic instructions that other coding tools might
312 read. Avoid referring to Crush-specific tools or workflows here.
313
314You can customize these paths using the `memory_paths` option in your
315configuration:
316
317```json
318{
319 "$schema": "https://charm.land/crush.json",
320 "options": {
321 "memory_paths": [
322 "/path/to/custom/memory/file.md",
323 "/path/to/folder/of/files/" // recursively load all .md files in folder
324 ]
325 }
326}
327```
328
329### Ignoring Files
330
331Crush respects `.gitignore` files by default, but you can also create a
332`.crushignore` file to specify additional files and directories that Crush
333should ignore. This is useful for excluding files that you want in version
334control but don't want Crush to consider when providing context.
335
336The `.crushignore` file uses the same syntax as `.gitignore` and can be placed
337in the root of your project or in subdirectories.
338
339### Allowing Tools
340
341By default, Crush will ask you for permission before running tool calls. If
342you'd like, you can allow tools to be executed without prompting you for
343permissions. Use this with care.
344
345```json
346{
347 "$schema": "https://charm.land/crush.json",
348 "permissions": {
349 "allowed_tools": [
350 "view",
351 "ls",
352 "grep",
353 "edit",
354 "mcp_context7_get-library-doc"
355 ]
356 }
357}
358```
359
360You can also skip all permission prompts entirely by running Crush with the
361`--yolo` flag. Be very, very careful with this feature.
362
363### Desktop notifications
364
365Crush sends desktop notifications when a tool call requires permission and when
366the agent finishes its turn. They're only sent when the terminal window isn't
367focused _and_ your terminal supports reporting the focus state.
368
369```json
370{
371 "$schema": "https://charm.land/crush.json",
372 "options": {
373 "disable_notifications": true // default
374 }
375}
376```
377
378To disable desktop notifications, set `disable_notifications` to `true` in your
379configuration. On macOS, notifications currently lack icons due to platform
380limitations.
381
382### Initialization
383
384When you initialize a project, Crush analyzes your codebase and creates
385a context file that helps it work more effectively in future sessions.
386By default, this file is named `AGENTS.md`, but you can customize the
387name and location with the `initialize_as` option:
388
389```json
390{
391 "$schema": "https://charm.land/crush.json",
392 "options": {
393 "initialize_as": "AGENTS.md"
394 }
395}
396```
397
398This is useful if you prefer a different naming convention or want to
399place the file in a specific directory (e.g., `CRUSH.md` or
400`docs/LLMs.md`). Crush will fill the file with project-specific context
401like build commands, code patterns, and conventions it discovered during
402initialization.
403
404### Attribution Settings
405
406By default, Crush adds attribution information to Git commits and pull requests
407it creates. You can customize this behavior with the `attribution` option:
408
409```json
410{
411 "$schema": "https://charm.land/crush.json",
412 "options": {
413 "attribution": {
414 "trailer_style": "co-authored-by",
415 "generated_with": true
416 }
417 }
418}
419```
420
421- `trailer_style`: Controls the attribution trailer added to commit messages
422 (default: `assisted-by`)
423 - `assisted-by`: Adds `Assisted-by: [Model Name] via Crush <crush@charm.land>`
424 (includes the model name)
425 - `co-authored-by`: Adds `Co-Authored-By: Crush <crush@charm.land>`
426 - `none`: No attribution trailer
427- `generated_with`: When true (default), adds `💘 Generated with Crush` line to
428 commit messages and PR descriptions
429
430### Custom Providers
431
432Crush supports custom provider configurations for both OpenAI-compatible and
433Anthropic-compatible APIs.
434
435> [!NOTE]
436> Note that we support two "types" for OpenAI. Make sure to choose the right one
437> to ensure the best experience!
438> * `openai` should be used when proxying or routing requests through OpenAI.
439> * `openai-compat` should be used when using non-OpenAI providers that have OpenAI-compatible APIs.
440
441#### OpenAI-Compatible APIs
442
443Here’s an example configuration for Deepseek, which uses an OpenAI-compatible
444API. Don't forget to set `DEEPSEEK_API_KEY` in your environment.
445
446```json
447{
448 "$schema": "https://charm.land/crush.json",
449 "providers": {
450 "deepseek": {
451 "type": "openai-compat",
452 "base_url": "https://api.deepseek.com/v1",
453 "api_key": "$DEEPSEEK_API_KEY",
454 "models": [
455 {
456 "id": "deepseek-chat",
457 "name": "Deepseek V3",
458 "cost_per_1m_in": 0.27,
459 "cost_per_1m_out": 1.1,
460 "cost_per_1m_in_cached": 0.07,
461 "cost_per_1m_out_cached": 1.1,
462 "context_window": 64000,
463 "default_max_tokens": 5000
464 }
465 ]
466 }
467 }
468}
469```
470
471#### Anthropic-Compatible APIs
472
473Custom Anthropic-compatible providers follow this format:
474
475```json
476{
477 "$schema": "https://charm.land/crush.json",
478 "providers": {
479 "custom-anthropic": {
480 "type": "anthropic",
481 "base_url": "https://api.anthropic.com/v1",
482 "api_key": "$ANTHROPIC_API_KEY",
483 "extra_headers": {
484 "anthropic-version": "2023-06-01"
485 },
486 "models": [
487 {
488 "id": "claude-sonnet-4-20250514",
489 "name": "Claude Sonnet 4",
490 "cost_per_1m_in": 3,
491 "cost_per_1m_out": 15,
492 "cost_per_1m_in_cached": 3.75,
493 "cost_per_1m_out_cached": 0.3,
494 "context_window": 200000,
495 "default_max_tokens": 50000,
496 "can_reason": true,
497 "supports_attachments": true
498 }
499 ]
500 }
501 }
502}
503```
504
505### Amazon Bedrock
506
507Crush currently supports running Anthropic models through Bedrock, with caching disabled.
508
509- A Bedrock provider will appear once you have AWS configured, i.e. `aws configure`
510- Crush also expects the `AWS_REGION` or `AWS_DEFAULT_REGION` to be set
511- To use a specific AWS profile set `AWS_PROFILE` in your environment, i.e. `AWS_PROFILE=myprofile crush`
512- Alternatively to `aws configure`, you can also just set `AWS_BEARER_TOKEN_BEDROCK`
513
514### Vertex AI Platform
515
516Vertex AI will appear in the list of available providers when `VERTEXAI_PROJECT` and `VERTEXAI_LOCATION` are set. You will also need to be authenticated:
517
518```bash
519gcloud auth application-default login
520```
521
522To add specific models to the configuration, configure as such:
523
524```json
525{
526 "$schema": "https://charm.land/crush.json",
527 "providers": {
528 "vertexai": {
529 "models": [
530 {
531 "id": "claude-sonnet-4@20250514",
532 "name": "VertexAI Sonnet 4",
533 "cost_per_1m_in": 3,
534 "cost_per_1m_out": 15,
535 "cost_per_1m_in_cached": 3.75,
536 "cost_per_1m_out_cached": 0.3,
537 "context_window": 200000,
538 "default_max_tokens": 50000,
539 "can_reason": true,
540 "supports_attachments": true
541 }
542 ]
543 }
544 }
545}
546```
547
548### Local Models
549
550Local models can also be configured via OpenAI-compatible API. Here are two common examples:
551
552#### Ollama
553
554```json
555{
556 "providers": {
557 "ollama": {
558 "name": "Ollama",
559 "base_url": "http://localhost:11434/v1/",
560 "type": "openai-compat",
561 "models": [
562 {
563 "name": "Qwen 3 30B",
564 "id": "qwen3:30b",
565 "context_window": 256000,
566 "default_max_tokens": 20000
567 }
568 ]
569 }
570 }
571}
572```
573
574#### LM Studio
575
576```json
577{
578 "providers": {
579 "lmstudio": {
580 "name": "LM Studio",
581 "base_url": "http://localhost:1234/v1/",
582 "type": "openai-compat",
583 "models": [
584 {
585 "name": "Qwen 3 30B",
586 "id": "qwen/qwen3-30b-a3b-2507",
587 "context_window": 256000,
588 "default_max_tokens": 20000
589 }
590 ]
591 }
592 }
593}
594```
595
596## Logging
597
598Sometimes you need to look at logs. Luckily, Crush logs all sorts of
599stuff. Logs are stored in `./.crush/logs/crush.log` relative to the project.
600
601The CLI also contains some helper commands to make perusing recent logs easier:
602
603```bash
604# Print the last 1000 lines
605crush logs
606
607# Print the last 500 lines
608crush logs --tail 500
609
610# Follow logs in real time
611crush logs --follow
612```
613
614Want more logging? Run `crush` with the `--debug` flag, or enable it in the
615config:
616
617```json
618{
619 "$schema": "https://charm.land/crush.json",
620 "options": {
621 "debug": true,
622 "debug_lsp": true
623 }
624}
625```
626
627## Provider Auto-Updates
628
629By default, Crush automatically checks for the latest and greatest list of
630providers and models from [Catwalk](https://github.com/charmbracelet/catwalk),
631the open source Crush provider database. This means that when new providers and
632models are available, or when model metadata changes, Crush automatically
633updates your local configuration.
634
635### Disabling automatic provider updates
636
637For those with restricted internet access, or those who prefer to work in
638air-gapped environments, this might not be want you want, and this feature can
639be disabled.
640
641To disable automatic provider updates, set `disable_provider_auto_update` into
642your `crush.json` config:
643
644```json
645{
646 "$schema": "https://charm.land/crush.json",
647 "options": {
648 "disable_provider_auto_update": true
649 }
650}
651```
652
653Or set the `CRUSH_DISABLE_PROVIDER_AUTO_UPDATE` environment variable:
654
655```bash
656export CRUSH_DISABLE_PROVIDER_AUTO_UPDATE=1
657```
658
659### Manually updating providers
660
661Manually updating providers is possible with the `crush update-providers`
662command:
663
664```bash
665# Update providers remotely from Catwalk.
666crush update-providers
667
668# Update providers from a custom Catwalk base URL.
669crush update-providers https://example.com/
670
671# Update providers from a local file.
672crush update-providers /path/to/local-providers.json
673
674# Reset providers to the embedded version, embedded at crush at build time.
675crush update-providers embedded
676
677# For more info:
678crush update-providers --help
679```
680
681## Metrics
682
683Crush records pseudonymous usage metrics (tied to a device-specific hash),
684which maintainers rely on to inform development and support priorities. The
685metrics include solely usage metadata; prompts and responses are NEVER
686collected.
687
688Details on exactly what’s collected are in the source code ([here](https://github.com/charmbracelet/crush/tree/main/internal/event)
689and [here](https://github.com/charmbracelet/crush/blob/main/internal/llm/agent/event.go)).
690
691You can opt out of metrics collection at any time by setting the environment
692variable by setting the following in your environment:
693
694```bash
695export CRUSH_DISABLE_METRICS=1
696```
697
698Or by setting the following in your config:
699
700```json
701{
702 "options": {
703 "disable_metrics": true
704 }
705}
706```
707
708Crush also respects the [`DO_NOT_TRACK`](https://consoledonottrack.com)
709convention which can be enabled via `export DO_NOT_TRACK=1`.
710
711## Contributing
712
713See the [contributing guide](https://github.com/charmbracelet/crush?tab=contributing-ov-file#contributing).
714
715## Whatcha think?
716
717We’d love to hear your thoughts on this project. Need help? We gotchu. You can find us on:
718
719- [Twitter](https://twitter.com/charmcli)
720- [Slack](https://charm.land/slack)
721- [Discord][discord]
722- [The Fediverse](https://mastodon.social/@charmcli)
723- [Bluesky](https://bsky.app/profile/charm.land)
724
725[discord]: https://charm.land/discord
726
727## License
728
729[FSL-1.1-MIT](https://github.com/charmbracelet/crush/raw/main/LICENSE.md)
730
731---
732
733Part of [Charm](https://charm.land).
734
735<a href="https://charm.land/"><img alt="The Charm logo" width="400" src="https://stuff.charm.sh/charm-banner-next.jpg" /></a>
736
737<!--prettier-ignore-->
738Charm热爱开源 • Charm loves open source