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