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` | AWS Bedrock (Claude) |
190| `AWS_SECRET_ACCESS_KEY` | AWS Bedrock (Claude) |
191| `AWS_REGION` | AWS Bedrock (Claude) |
192| `AWS_PROFILE` | AWS Bedrock (Custom Profile) |
193| `AWS_BEARER_TOKEN_BEDROCK` | AWS 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### Initialization
364
365When you initialize a project, Crush analyzes your codebase and creates
366a context file that helps it work more effectively in future sessions.
367By default, this file is named `AGENTS.md`, but you can customize the
368name and location with the `initialize_as` option:
369
370```json
371{
372 "$schema": "https://charm.land/crush.json",
373 "options": {
374 "initialize_as": "AGENTS.md"
375 }
376}
377```
378
379This is useful if you prefer a different naming convention or want to
380place the file in a specific directory (e.g., `CRUSH.md` or
381`docs/LLMs.md`). Crush will fill the file with project-specific context
382like build commands, code patterns, and conventions it discovered during
383initialization.
384
385### Attribution Settings
386
387By default, Crush adds attribution information to Git commits and pull requests
388it creates. You can customize this behavior with the `attribution` option:
389
390```json
391{
392 "$schema": "https://charm.land/crush.json",
393 "options": {
394 "attribution": {
395 "trailer_style": "co-authored-by",
396 "generated_with": true
397 }
398 }
399}
400```
401
402- `trailer_style`: Controls the attribution trailer added to commit messages
403 (default: `assisted-by`)
404 - `assisted-by`: Adds `Assisted-by: [Model Name] via Crush <crush@charm.land>`
405 (includes the model name)
406 - `co-authored-by`: Adds `Co-Authored-By: Crush <crush@charm.land>`
407 - `none`: No attribution trailer
408- `generated_with`: When true (default), adds `💘 Generated with Crush` line to
409 commit messages and PR descriptions
410
411### Custom Providers
412
413Crush supports custom provider configurations for both OpenAI-compatible and
414Anthropic-compatible APIs.
415
416> [!NOTE]
417> Note that we support two "types" for OpenAI. Make sure to choose the right one
418> to ensure the best experience!
419> * `openai` should be used when proxying or routing requests through OpenAI.
420> * `openai-compat` should be used when using non-OpenAI providers that have OpenAI-compatible APIs.
421
422#### OpenAI-Compatible APIs
423
424Here’s an example configuration for Deepseek, which uses an OpenAI-compatible
425API. Don't forget to set `DEEPSEEK_API_KEY` in your environment.
426
427```json
428{
429 "$schema": "https://charm.land/crush.json",
430 "providers": {
431 "deepseek": {
432 "type": "openai-compat",
433 "base_url": "https://api.deepseek.com/v1",
434 "api_key": "$DEEPSEEK_API_KEY",
435 "models": [
436 {
437 "id": "deepseek-chat",
438 "name": "Deepseek V3",
439 "cost_per_1m_in": 0.27,
440 "cost_per_1m_out": 1.1,
441 "cost_per_1m_in_cached": 0.07,
442 "cost_per_1m_out_cached": 1.1,
443 "context_window": 64000,
444 "default_max_tokens": 5000
445 }
446 ]
447 }
448 }
449}
450```
451
452#### Anthropic-Compatible APIs
453
454Custom Anthropic-compatible providers follow this format:
455
456```json
457{
458 "$schema": "https://charm.land/crush.json",
459 "providers": {
460 "custom-anthropic": {
461 "type": "anthropic",
462 "base_url": "https://api.anthropic.com/v1",
463 "api_key": "$ANTHROPIC_API_KEY",
464 "extra_headers": {
465 "anthropic-version": "2023-06-01"
466 },
467 "models": [
468 {
469 "id": "claude-sonnet-4-20250514",
470 "name": "Claude Sonnet 4",
471 "cost_per_1m_in": 3,
472 "cost_per_1m_out": 15,
473 "cost_per_1m_in_cached": 3.75,
474 "cost_per_1m_out_cached": 0.3,
475 "context_window": 200000,
476 "default_max_tokens": 50000,
477 "can_reason": true,
478 "supports_attachments": true
479 }
480 ]
481 }
482 }
483}
484```
485
486### Amazon Bedrock
487
488Crush currently supports running Anthropic models through Bedrock, with caching disabled.
489
490- A Bedrock provider will appear once you have AWS configured, i.e. `aws configure`
491- Crush also expects the `AWS_REGION` or `AWS_DEFAULT_REGION` to be set
492- To use a specific AWS profile set `AWS_PROFILE` in your environment, i.e. `AWS_PROFILE=myprofile crush`
493- Alternatively to `aws configure`, you can also just set `AWS_BEARER_TOKEN_BEDROCK`
494
495### Vertex AI Platform
496
497Vertex AI will appear in the list of available providers when `VERTEXAI_PROJECT` and `VERTEXAI_LOCATION` are set. You will also need to be authenticated:
498
499```bash
500gcloud auth application-default login
501```
502
503To add specific models to the configuration, configure as such:
504
505```json
506{
507 "$schema": "https://charm.land/crush.json",
508 "providers": {
509 "vertexai": {
510 "models": [
511 {
512 "id": "claude-sonnet-4@20250514",
513 "name": "VertexAI Sonnet 4",
514 "cost_per_1m_in": 3,
515 "cost_per_1m_out": 15,
516 "cost_per_1m_in_cached": 3.75,
517 "cost_per_1m_out_cached": 0.3,
518 "context_window": 200000,
519 "default_max_tokens": 50000,
520 "can_reason": true,
521 "supports_attachments": true
522 }
523 ]
524 }
525 }
526}
527```
528
529### Local Models
530
531Local models can also be configured via OpenAI-compatible API. Here are two common examples:
532
533#### Ollama
534
535```json
536{
537 "providers": {
538 "ollama": {
539 "name": "Ollama",
540 "base_url": "http://localhost:11434/v1/",
541 "type": "openai-compat",
542 "models": [
543 {
544 "name": "Qwen 3 30B",
545 "id": "qwen3:30b",
546 "context_window": 256000,
547 "default_max_tokens": 20000
548 }
549 ]
550 }
551 }
552}
553```
554
555#### LM Studio
556
557```json
558{
559 "providers": {
560 "lmstudio": {
561 "name": "LM Studio",
562 "base_url": "http://localhost:1234/v1/",
563 "type": "openai-compat",
564 "models": [
565 {
566 "name": "Qwen 3 30B",
567 "id": "qwen/qwen3-30b-a3b-2507",
568 "context_window": 256000,
569 "default_max_tokens": 20000
570 }
571 ]
572 }
573 }
574}
575```
576
577## Logging
578
579Sometimes you need to look at logs. Luckily, Crush logs all sorts of
580stuff. Logs are stored in `./.crush/logs/crush.log` relative to the project.
581
582The CLI also contains some helper commands to make perusing recent logs easier:
583
584```bash
585# Print the last 1000 lines
586crush logs
587
588# Print the last 500 lines
589crush logs --tail 500
590
591# Follow logs in real time
592crush logs --follow
593```
594
595Want more logging? Run `crush` with the `--debug` flag, or enable it in the
596config:
597
598```json
599{
600 "$schema": "https://charm.land/crush.json",
601 "options": {
602 "debug": true,
603 "debug_lsp": true
604 }
605}
606```
607
608## Provider Auto-Updates
609
610By default, Crush automatically checks for the latest and greatest list of
611providers and models from [Catwalk](https://github.com/charmbracelet/catwalk),
612the open source Crush provider database. This means that when new providers and
613models are available, or when model metadata changes, Crush automatically
614updates your local configuration.
615
616### Disabling automatic provider updates
617
618For those with restricted internet access, or those who prefer to work in
619air-gapped environments, this might not be want you want, and this feature can
620be disabled.
621
622To disable automatic provider updates, set `disable_provider_auto_update` into
623your `crush.json` config:
624
625```json
626{
627 "$schema": "https://charm.land/crush.json",
628 "options": {
629 "disable_provider_auto_update": true
630 }
631}
632```
633
634Or set the `CRUSH_DISABLE_PROVIDER_AUTO_UPDATE` environment variable:
635
636```bash
637export CRUSH_DISABLE_PROVIDER_AUTO_UPDATE=1
638```
639
640### Manually updating providers
641
642Manually updating providers is possible with the `crush update-providers`
643command:
644
645```bash
646# Update providers remotely from Catwalk.
647crush update-providers
648
649# Update providers from a custom Catwalk base URL.
650crush update-providers https://example.com/
651
652# Update providers from a local file.
653crush update-providers /path/to/local-providers.json
654
655# Reset providers to the embedded version, embedded at crush at build time.
656crush update-providers embedded
657
658# For more info:
659crush update-providers --help
660```
661
662## Metrics
663
664Crush records pseudonymous usage metrics (tied to a device-specific hash),
665which maintainers rely on to inform development and support priorities. The
666metrics include solely usage metadata; prompts and responses are NEVER
667collected.
668
669Details on exactly what’s collected are in the source code ([here](https://github.com/charmbracelet/crush/tree/main/internal/event)
670and [here](https://github.com/charmbracelet/crush/blob/main/internal/llm/agent/event.go)).
671
672You can opt out of metrics collection at any time by setting the environment
673variable by setting the following in your environment:
674
675```bash
676export CRUSH_DISABLE_METRICS=1
677```
678
679Or by setting the following in your config:
680
681```json
682{
683 "options": {
684 "disable_metrics": true
685 }
686}
687```
688
689Crush also respects the [`DO_NOT_TRACK`](https://consoledonottrack.com)
690convention which can be enabled via `export DO_NOT_TRACK=1`.
691
692## A Note on Claude Max and GitHub Copilot
693
694Crush only supports model providers through official, compliant APIs. We do not
695support or endorse any methods that rely on personal Claude Max and GitHub
696Copilot accounts or OAuth workarounds, which violate Anthropic and
697Microsoft’s Terms of Service.
698
699We’re committed to building sustainable, trusted integrations with model
700providers. If you’re a provider interested in working with us,
701[reach out](mailto:vt100@charm.sh).
702
703## Contributing
704
705See the [contributing guide](https://github.com/charmbracelet/crush?tab=contributing-ov-file#contributing).
706
707## Whatcha think?
708
709We’d love to hear your thoughts on this project. Need help? We gotchu. You can find us on:
710
711- [Twitter](https://twitter.com/charmcli)
712- [Slack](https://charm.land/slack)
713- [Discord][discord]
714- [The Fediverse](https://mastodon.social/@charmcli)
715- [Bluesky](https://bsky.app/profile/charm.land)
716
717[discord]: https://charm.land/discord
718
719## License
720
721[FSL-1.1-MIT](https://github.com/charmbracelet/crush/raw/main/LICENSE.md)
722
723---
724
725Part of [Charm](https://charm.land).
726
727<a href="https://charm.land/"><img alt="The Charm logo" width="400" src="https://stuff.charm.sh/charm-banner-next.jpg" /></a>
728
729<!--prettier-ignore-->
730Charm热爱开源 • Charm loves open source