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/cf8ca3ce-8b02-43f0-9d0f-5a331488da4b" /></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), Android, FreeBSD, OpenBSD, and NetBSD
22- **Industrial Grade:** built on the Charm ecosystem, powering 25k+ applications, from leading open source projects to business-critical infrastructure
23
24## Installation
25
26Use a package manager:
27
28```bash
29# Homebrew
30brew install charmbracelet/tap/crush
31
32# NPM
33npm install -g @charmland/crush
34
35# Arch Linux (btw)
36yay -S crush-bin
37
38# Nix
39nix run github:numtide/nix-ai-tools#crush
40
41# FreeBSD
42pkg install crush
43```
44
45Windows users:
46
47```bash
48# Winget
49winget install charmbracelet.crush
50
51# Scoop
52scoop bucket add charm https://github.com/charmbracelet/scoop-bucket.git
53scoop install crush
54```
55
56<details>
57<summary><strong>Nix (NUR)</strong></summary>
58
59Crush is available via the official Charm [NUR](https://github.com/nix-community/NUR) in `nur.repos.charmbracelet.crush`, which is the most up-to-date way to get Crush in Nix.
60
61You can also try out Crush via the NUR with `nix-shell`:
62
63```bash
64# Add the NUR channel.
65nix-channel --add https://github.com/nix-community/NUR/archive/main.tar.gz nur
66nix-channel --update
67
68# Get Crush in a Nix shell.
69nix-shell -p '(import <nur> { pkgs = import <nixpkgs> {}; }).repos.charmbracelet.crush'
70```
71
72### NixOS & Home Manager Module Usage via NUR
73
74Crush provides NixOS and Home Manager modules via NUR.
75You 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 :)
76
77```nix
78{
79 inputs = {
80 nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
81 nur.url = "github:nix-community/NUR";
82 };
83
84 outputs = { self, nixpkgs, nur, ... }: {
85 nixosConfigurations.your-hostname = nixpkgs.lib.nixosSystem {
86 system = "x86_64-linux";
87 modules = [
88 nur.modules.nixos.default
89 nur.repos.charmbracelet.modules.crush
90 {
91 programs.crush = {
92 enable = true;
93 settings = {
94 providers = {
95 openai = {
96 id = "openai";
97 name = "OpenAI";
98 base_url = "https://api.openai.com/v1";
99 type = "openai";
100 api_key = "sk-fake123456789abcdef...";
101 models = [
102 {
103 id = "gpt-4";
104 name = "GPT-4";
105 }
106 ];
107 };
108 };
109 lsp = {
110 go = { command = "gopls"; enabled = true; };
111 nix = { command = "nil"; enabled = true; };
112 };
113 options = {
114 context_paths = [ "/etc/nixos/configuration.nix" ];
115 tui = { compact_mode = true; };
116 debug = false;
117 };
118 };
119 };
120 }
121 ];
122 };
123 };
124}
125```
126
127</details>
128
129<details>
130<summary><strong>Debian/Ubuntu</strong></summary>
131
132```bash
133sudo mkdir -p /etc/apt/keyrings
134curl -fsSL https://repo.charm.sh/apt/gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/charm.gpg
135echo "deb [signed-by=/etc/apt/keyrings/charm.gpg] https://repo.charm.sh/apt/ * *" | sudo tee /etc/apt/sources.list.d/charm.list
136sudo apt update && sudo apt install crush
137```
138
139</details>
140
141<details>
142<summary><strong>Fedora/RHEL</strong></summary>
143
144```bash
145echo '[charm]
146name=Charm
147baseurl=https://repo.charm.sh/yum/
148enabled=1
149gpgcheck=1
150gpgkey=https://repo.charm.sh/yum/gpg.key' | sudo tee /etc/yum.repos.d/charm.repo
151sudo yum install crush
152```
153
154</details>
155
156Or, download it:
157
158- [Packages][releases] are available in Debian and RPM formats
159- [Binaries][releases] are available for Linux, macOS, Windows, FreeBSD, OpenBSD, and NetBSD
160
161[releases]: https://github.com/charmbracelet/crush/releases
162
163Or just install it with Go:
164
165```
166go install github.com/charmbracelet/crush@latest
167```
168
169> [!WARNING]
170> Productivity may increase when using Crush and you may find yourself nerd
171> sniped when first using the application. If the symptoms persist, join the
172> [Slack][slack] or [Discord][discord] and nerd snipe the rest of us.
173
174## Getting Started
175
176The quickest way to get started is to grab an API key for your preferred
177provider such as Anthropic, OpenAI, Groq, OpenRouter, or Vercel AI Gateway and just start
178Crush. You'll be prompted to enter your API key.
179
180That said, you can also set environment variables for preferred providers.
181
182| Environment Variable | Provider |
183| --------------------------- | -------------------------------------------------- |
184| `HYPER_API_KEY` | Charm Hyper |
185| `ANTHROPIC_API_KEY` | Anthropic |
186| `OPENAI_API_KEY` | OpenAI |
187| `VERCEL_API_KEY` | Vercel AI Gateway |
188| `GEMINI_API_KEY` | Google Gemini |
189| `SYNTHETIC_API_KEY` | Synthetic |
190| `ZAI_API_KEY` | Z.ai |
191| `MINIMAX_API_KEY` | MiniMax |
192| `HF_TOKEN` | Hugging Face Inference |
193| `CEREBRAS_API_KEY` | Cerebras |
194| `OPENROUTER_API_KEY` | OpenRouter |
195| `IONET_API_KEY` | io.net |
196| `GROQ_API_KEY` | Groq |
197| `AVIAN_API_KEY` | Avian |
198| `OPENCODE_API_KEY` | OpenCode Zen & Go |
199| `VERTEXAI_PROJECT` | Google Cloud VertexAI (Gemini) |
200| `VERTEXAI_LOCATION` | Google Cloud VertexAI (Gemini) |
201| `AWS_ACCESS_KEY_ID` | Amazon Bedrock (Claude) |
202| `AWS_SECRET_ACCESS_KEY` | Amazon Bedrock (Claude) |
203| `AWS_REGION` | Amazon Bedrock (Claude) |
204| `AWS_PROFILE` | Amazon Bedrock (Custom Profile) |
205| `AWS_BEARER_TOKEN_BEDROCK` | Amazon Bedrock |
206| `AZURE_OPENAI_API_ENDPOINT` | Azure OpenAI models |
207| `AZURE_OPENAI_API_KEY` | Azure OpenAI models (optional when using Entra ID) |
208| `AZURE_OPENAI_API_VERSION` | Azure OpenAI models |
209
210### Subscriptions
211
212If you prefer subscription-based usage, here are some plans that work well in
213Crush:
214
215- [Synthetic](https://synthetic.new/pricing)
216- [GLM Coding Plan](https://z.ai/subscribe)
217- [Kimi Code](https://www.kimi.com/membership/pricing)
218- [MiniMax Coding Plan](https://platform.minimax.io/subscribe/coding-plan)
219
220### By the Way
221
222Is there a provider you’d like to see in Crush? Is there an existing model that needs an update?
223
224Crush’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.
225
226<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>
227
228## Configuration
229
230> [!TIP]
231> Crush ships with a builtin `crush-config` skill for configuring itself. In
232> many cases you can simply ask Crush to configure itself.
233
234Crush runs great with no configuration. That said, if you do need or want to
235customize Crush, configuration can be added either local to the project itself,
236or globally, with the following priority:
237
2381. `.crush.json`
2392. `crush.json`
2403. `$HOME/.config/crush/crush.json`
241
242Configuration itself is stored as a JSON object:
243
244```json
245{
246 "this-setting": { "this": "that" },
247 "that-setting": ["ceci", "cela"]
248}
249```
250
251As an additional note, Crush also stores ephemeral data, such as application
252state, in one additional location:
253
254```bash
255# Unix
256$HOME/.local/share/crush/crush.json
257
258# Windows
259%LOCALAPPDATA%\crush\crush.json
260```
261
262> [!TIP]
263> You can override the user and data config locations by setting:
264>
265> - `CRUSH_GLOBAL_CONFIG`
266> - `CRUSH_GLOBAL_DATA`
267
268### LSPs
269
270Crush can use LSPs for additional context to help inform its decisions, just
271like you would. LSPs can be added manually like so:
272
273```json
274{
275 "$schema": "https://charm.land/crush.json",
276 "lsp": {
277 "go": {
278 "command": "gopls",
279 "env": {
280 "GOTOOLCHAIN": "go1.24.5"
281 }
282 },
283 "typescript": {
284 "command": "typescript-language-server",
285 "args": ["--stdio"]
286 },
287 "nix": {
288 "command": "nil"
289 }
290 }
291}
292```
293
294### MCPs
295
296Crush also supports Model Context Protocol (MCP) servers through three transport
297types: `stdio` for command-line servers, `http` for HTTP endpoints, and `sse`
298for Server-Sent Events.
299
300Shell-style value expansion (`$VAR`, `${VAR:-default}`, `$(command)`, quoting,
301nesting) works in `command`, `args`, `env`, `headers`, and `url`, so
302file-based secrets work out of the box. You can use values like `"$TOKEN"`
303or `"$(cat /path/to/secret/token)"`. Expansion runs through Crush's embedded
304shell, so the same syntax works on every supported system, Windows included.
305
306Unset variables expand to the empty string by default, matching bash. For
307required credentials, use `${VAR:?message}` so an unset variable fails loudly
308at load time with `message` instead of silently resolving to empty:
309
310```json
311{ "api_key": "${CODEBERG_TOKEN:?set CODEBERG_TOKEN}" }
312```
313
314Headers (both MCP `headers` and provider `extra_headers`) whose value
315resolves to the empty string are dropped from the outgoing request rather
316than sent as `Header:`. That keeps optional env-gated headers like
317`"OpenAI-Organization": "$OPENAI_ORG_ID"` clean when the variable is unset.
318
319Provider `extra_body` is a non-expanding JSON passthrough; put env-driven
320values in `extra_headers` or the provider's `api_key` / `base_url`, all of
321which do expand.
322
323> **Security note:** `crush.json` is trusted code. Any `$(...)` in it runs at
324> load time with your shell's privileges, before the UI appears. Don't launch
325> Crush in a directory whose `crush.json` you haven't reviewed.
326
327```json
328{
329 "$schema": "https://charm.land/crush.json",
330 "mcp": {
331 "filesystem": {
332 "type": "stdio",
333 "command": "node",
334 "args": ["/path/to/mcp-server.js"],
335 "timeout": 120,
336 "disabled": false,
337 "disabled_tools": ["some-tool-name"],
338 "env": {
339 "NODE_ENV": "production"
340 }
341 },
342 "github": {
343 "type": "http",
344 "url": "https://api.githubcopilot.com/mcp/",
345 "timeout": 120,
346 "disabled": false,
347 "disabled_tools": ["create_issue", "create_pull_request"],
348 "headers": {
349 "Authorization": "Bearer $GH_PAT"
350 }
351 },
352 "streaming-service": {
353 "type": "sse",
354 "url": "https://example.com/mcp/sse",
355 "timeout": 120,
356 "disabled": false,
357 "headers": {
358 "API-Key": "$(echo $API_KEY)"
359 }
360 }
361 }
362}
363```
364
365### Hooks
366
367Crush has preliminary support for hooks. For details, see
368[the hook guide](./docs/hooks/).
369
370### Ignoring Files
371
372Crush respects `.gitignore` files by default, but you can also create a
373`.crushignore` file to specify additional files and directories that Crush
374should ignore. This is useful for excluding files that you want in version
375control but don't want Crush to consider when providing context.
376
377The `.crushignore` file uses the same syntax as `.gitignore` and can be placed
378in the root of your project or in subdirectories.
379
380### Allowing Tools
381
382By default, Crush will ask you for permission before running tool calls. If
383you'd like, you can allow tools to be executed without prompting you for
384permissions. Use this with care.
385
386```json
387{
388 "$schema": "https://charm.land/crush.json",
389 "permissions": {
390 "allowed_tools": [
391 "view",
392 "ls",
393 "grep",
394 "edit",
395 "mcp_context7_get-library-doc"
396 ]
397 }
398}
399```
400
401You can also skip all permission prompts entirely by running Crush with the
402`--yolo` flag. Be very, very careful with this feature.
403
404### Disabling Built-In Tools
405
406If you'd like to prevent Crush from using certain built-in tools entirely, you
407can disable them via the `options.disabled_tools` list. Disabled tools are
408completely hidden from the agent.
409
410```json
411{
412 "$schema": "https://charm.land/crush.json",
413 "options": {
414 "disabled_tools": ["bash", "sourcegraph"]
415 }
416}
417```
418
419To disable tools from MCP servers, see the [MCP config section](#mcps).
420
421### Disabling Skills
422
423If you'd like to prevent Crush from using certain skills entirely, you can
424disable them via the `options.disabled_skills` list. Disabled skills are hidden
425from the agent, including builtin skills and skills discovered from disk.
426
427```json
428{
429 "$schema": "https://charm.land/crush.json",
430 "options": {
431 "disabled_skills": ["crush-config"]
432 }
433}
434```
435
436### Agent Skills
437
438Crush supports the [Agent Skills](https://agentskills.io) open standard for
439extending agent capabilities with reusable skill packages. Skills are folders
440containing a `SKILL.md` file with instructions that Crush can discover and
441activate on demand.
442
443The global paths we looks for skills are:
444
445* `$CRUSH_SKILLS_DIR`
446* `$XDG_CONFIG_HOME/agents/skills` or `~/.config/agents/skills/`
447* `$XDG_CONFIG_HOME/crush/skills` or `~/.config/crush/skills/`
448* On Windows, we _also_ look at
449 * `%LOCALAPPDATA%\agents\skills\` or `%USERPROFILE%\AppData\Local\agents\skills\`
450 * `%LOCALAPPDATA%\crush\skills\` or `%USERPROFILE%\AppData\Local\crush\skills\`
451* Additional paths configured via `options.skills_paths`
452
453On top of that, we _also_ load skills in your project from the following
454relative paths:
455
456* `.agents/skills`
457* `.crush/skills`
458* `.claude/skills`
459* `.cursor/skills`
460
461```jsonc
462{
463 "$schema": "https://charm.land/crush.json",
464 "options": {
465 "skills_paths": [
466 "~/.config/crush/skills", // Windows: "%LOCALAPPDATA%\\crush\\skills",
467 "./project-skills",
468 ],
469 },
470}
471```
472
473You can get started with example skills from [anthropics/skills](https://github.com/anthropics/skills):
474
475```bash
476# Unix
477mkdir -p ~/.config/crush/skills
478cd ~/.config/crush/skills
479git clone https://github.com/anthropics/skills.git _temp
480mv _temp/skills/* . && rm -rf _temp
481```
482
483```powershell
484# Windows (PowerShell)
485mkdir -Force "$env:LOCALAPPDATA\crush\skills"
486cd "$env:LOCALAPPDATA\crush\skills"
487git clone https://github.com/anthropics/skills.git _temp
488mv _temp/skills/* . ; rm -r -force _temp
489```
490
491### Desktop notifications
492
493Crush sends desktop notifications when a tool call requires permission and when
494the agent finishes its turn. They're only sent when the terminal window isn't
495focused _and_ your terminal supports reporting the focus state.
496
497```jsonc
498{
499 "$schema": "https://charm.land/crush.json",
500 "options": {
501 "disable_notifications": false, // default
502 },
503}
504```
505
506To disable desktop notifications, set `disable_notifications` to `true` in your
507configuration. On macOS, notifications currently lack icons due to platform
508limitations.
509
510### Initialization
511
512When you initialize a project, Crush analyzes your codebase and creates
513a context file that helps it work more effectively in future sessions.
514By default, this file is named `AGENTS.md`, but you can customize the
515name and location with the `initialize_as` option:
516
517```json
518{
519 "$schema": "https://charm.land/crush.json",
520 "options": {
521 "initialize_as": "AGENTS.md"
522 }
523}
524```
525
526This is useful if you prefer a different naming convention or want to
527place the file in a specific directory (e.g., `CRUSH.md` or
528`docs/LLMs.md`). Crush will fill the file with project-specific context
529like build commands, code patterns, and conventions it discovered during
530initialization.
531
532### Attribution Settings
533
534By default, Crush adds attribution information to Git commits and pull requests
535it creates. You can customize this behavior with the `attribution` option:
536
537```json
538{
539 "$schema": "https://charm.land/crush.json",
540 "options": {
541 "attribution": {
542 "trailer_style": "co-authored-by",
543 "generated_with": true
544 }
545 }
546}
547```
548
549- `trailer_style`: Controls the attribution trailer added to commit messages
550 (default: `assisted-by`)
551 - `assisted-by`: Adds `Assisted-by: [Model Name] via Crush <crush@charm.land>`
552 (includes the model name)
553 - `co-authored-by`: Adds `Co-Authored-By: Crush <crush@charm.land>`
554 - `none`: No attribution trailer
555- `generated_with`: When true (default), adds `💘 Generated with Crush` line to
556 commit messages and PR descriptions
557
558### Custom Providers
559
560Crush supports custom provider configurations for both OpenAI-compatible and
561Anthropic-compatible APIs.
562
563> [!NOTE]
564> Note that we support two "types" for OpenAI. Make sure to choose the right one
565> to ensure the best experience!
566>
567> - `openai` should be used when proxying or routing requests through OpenAI.
568> - `openai-compat` should be used when using non-OpenAI providers that have OpenAI-compatible APIs.
569
570#### OpenAI-Compatible APIs
571
572Here’s an example configuration for Deepseek, which uses an OpenAI-compatible
573API. Don't forget to set `DEEPSEEK_API_KEY` in your environment.
574
575```json
576{
577 "$schema": "https://charm.land/crush.json",
578 "providers": {
579 "deepseek": {
580 "type": "openai-compat",
581 "base_url": "https://api.deepseek.com/v1",
582 "api_key": "$DEEPSEEK_API_KEY",
583 "models": [
584 {
585 "id": "deepseek-chat",
586 "name": "Deepseek V3",
587 "cost_per_1m_in": 0.27,
588 "cost_per_1m_out": 1.1,
589 "cost_per_1m_in_cached": 0.07,
590 "cost_per_1m_out_cached": 1.1,
591 "context_window": 64000,
592 "default_max_tokens": 5000
593 }
594 ]
595 }
596 }
597}
598```
599
600#### Anthropic-Compatible APIs
601
602Custom Anthropic-compatible providers follow this format:
603
604```json
605{
606 "$schema": "https://charm.land/crush.json",
607 "providers": {
608 "custom-anthropic": {
609 "type": "anthropic",
610 "base_url": "https://api.anthropic.com/v1",
611 "api_key": "$ANTHROPIC_API_KEY",
612 "extra_headers": {
613 "anthropic-version": "2023-06-01"
614 },
615 "models": [
616 {
617 "id": "claude-sonnet-4-20250514",
618 "name": "Claude Sonnet 4",
619 "cost_per_1m_in": 3,
620 "cost_per_1m_out": 15,
621 "cost_per_1m_in_cached": 3.75,
622 "cost_per_1m_out_cached": 0.3,
623 "context_window": 200000,
624 "default_max_tokens": 50000,
625 "can_reason": true,
626 "supports_attachments": true
627 }
628 ]
629 }
630 }
631}
632```
633
634### Amazon Bedrock
635
636Crush currently supports running Anthropic models through Bedrock, with caching disabled.
637
638- A Bedrock provider will appear once you have AWS configured, i.e. `aws configure`
639- Crush also expects the `AWS_REGION` or `AWS_DEFAULT_REGION` to be set
640- To use a specific AWS profile set `AWS_PROFILE` in your environment, i.e. `AWS_PROFILE=myprofile crush`
641- Alternatively to `aws configure`, you can also just set `AWS_BEARER_TOKEN_BEDROCK`
642
643### Vertex AI Platform
644
645Vertex AI will appear in the list of available providers when `VERTEXAI_PROJECT` and `VERTEXAI_LOCATION` are set. You will also need to be authenticated:
646
647```bash
648gcloud auth application-default login
649```
650
651To add specific models to the configuration, configure as such:
652
653```json
654{
655 "$schema": "https://charm.land/crush.json",
656 "providers": {
657 "vertexai": {
658 "models": [
659 {
660 "id": "claude-sonnet-4@20250514",
661 "name": "VertexAI Sonnet 4",
662 "cost_per_1m_in": 3,
663 "cost_per_1m_out": 15,
664 "cost_per_1m_in_cached": 3.75,
665 "cost_per_1m_out_cached": 0.3,
666 "context_window": 200000,
667 "default_max_tokens": 50000,
668 "can_reason": true,
669 "supports_attachments": true
670 }
671 ]
672 }
673 }
674}
675```
676
677### Local Models
678
679Local models can also be configured via OpenAI-compatible API. Here are two common examples:
680
681#### Ollama
682
683```json
684{
685 "providers": {
686 "ollama": {
687 "name": "Ollama",
688 "base_url": "http://localhost:11434/v1/",
689 "type": "openai-compat",
690 "models": [
691 {
692 "name": "Qwen 3 30B",
693 "id": "qwen3:30b",
694 "context_window": 256000,
695 "default_max_tokens": 20000
696 }
697 ]
698 }
699 }
700}
701```
702
703#### LM Studio
704
705```json
706{
707 "providers": {
708 "lmstudio": {
709 "name": "LM Studio",
710 "base_url": "http://localhost:1234/v1/",
711 "type": "openai-compat",
712 "models": [
713 {
714 "name": "Qwen 3 30B",
715 "id": "qwen/qwen3-30b-a3b-2507",
716 "context_window": 256000,
717 "default_max_tokens": 20000
718 }
719 ]
720 }
721 }
722}
723```
724
725## Logging
726
727Sometimes you need to look at logs. Luckily, Crush logs all sorts of
728stuff. Logs are stored in `./.crush/logs/crush.log` relative to the project.
729
730The CLI also contains some helper commands to make perusing recent logs easier:
731
732```bash
733# Print the last 1000 lines
734crush logs
735
736# Print the last 500 lines
737crush logs --tail 500
738
739# Follow logs in real time
740crush logs --follow
741```
742
743Want more logging? Run `crush` with the `--debug` flag, or enable it in the
744config:
745
746```json
747{
748 "$schema": "https://charm.land/crush.json",
749 "options": {
750 "debug": true,
751 "debug_lsp": true
752 }
753}
754```
755
756## Provider Auto-Updates
757
758By default, Crush automatically checks for the latest and greatest list of
759providers and models from [Catwalk](https://github.com/charmbracelet/catwalk),
760the open source Crush provider database. This means that when new providers and
761models are available, or when model metadata changes, Crush automatically
762updates your local configuration.
763
764### Disabling automatic provider updates
765
766For those with restricted internet access, or those who prefer to work in
767air-gapped environments, this might not be want you want, and this feature can
768be disabled.
769
770To disable automatic provider updates, set `disable_provider_auto_update` into
771your `crush.json` config:
772
773```json
774{
775 "$schema": "https://charm.land/crush.json",
776 "options": {
777 "disable_provider_auto_update": true
778 }
779}
780```
781
782Or set the `CRUSH_DISABLE_PROVIDER_AUTO_UPDATE` environment variable:
783
784```bash
785export CRUSH_DISABLE_PROVIDER_AUTO_UPDATE=1
786```
787
788### Manually updating providers
789
790Manually updating providers is possible with the `crush update-providers`
791command:
792
793```bash
794# Update providers remotely from Catwalk.
795crush update-providers
796
797# Update providers from a custom Catwalk base URL.
798crush update-providers https://example.com/
799
800# Update providers from a local file.
801crush update-providers /path/to/local-providers.json
802
803# Reset providers to the embedded version, embedded at crush at build time.
804crush update-providers embedded
805
806# For more info:
807crush update-providers --help
808```
809
810## Metrics
811
812Crush records pseudonymous usage metrics (tied to a device-specific hash),
813which maintainers rely on to inform development and support priorities. The
814metrics include solely usage metadata; prompts and responses are NEVER
815collected.
816
817Details on exactly what’s collected are in the source code ([here](https://github.com/charmbracelet/crush/tree/main/internal/event)
818and [here](https://github.com/charmbracelet/crush/blob/main/internal/llm/agent/event.go)).
819
820You can opt out of metrics collection at any time by setting the environment
821variable by setting the following in your environment:
822
823```bash
824export CRUSH_DISABLE_METRICS=1
825```
826
827Or by setting the following in your config:
828
829```json
830{
831 "options": {
832 "disable_metrics": true
833 }
834}
835```
836
837Crush also respects the [`DO_NOT_TRACK`](https://donottrack.sh/) convention
838which can be enabled via `export DO_NOT_TRACK=1`.
839
840## Q&A
841
842### Why is clipboard copy and paste not working?
843
844Installing an extra tool might be needed on Unix-like environments.
845
846| Environment | Tool |
847| ------------------- | ------------------------ |
848| Windows | Native support |
849| macOS | Native support |
850| Linux/BSD + Wayland | `wl-copy` and `wl-paste` |
851| Linux/BSD + X11 | `xclip` or `xsel` |
852
853## Contributing
854
855See the [contributing guide](https://github.com/charmbracelet/crush?tab=contributing-ov-file#contributing).
856
857## Whatcha think?
858
859We’d love to hear your thoughts on this project. Need help? We gotchu. You can find us on:
860
861- [Twitter](https://twitter.com/charmcli)
862- [Slack][slack]
863- [Discord][discord]
864- [The Fediverse](https://mastodon.social/@charmcli)
865- [Bluesky](https://bsky.app/profile/charm.land)
866
867[slack]: https://charm.land/slack
868[discord]: https://charm.land/discord
869
870## License
871
872[FSL-1.1-MIT](https://github.com/charmbracelet/crush/raw/main/LICENSE.md)
873
874---
875
876Part of [Charm](https://charm.land).
877
878<a href="https://charm.land/"><img alt="The Charm logo" width="400" src="https://stuff.charm.sh/charm-banner-softy.jpg" /></a>
879
880<!--prettier-ignore-->
881Charm热爱开源 • Charm loves open source