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