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| `ANTHROPIC_API_KEY` | Anthropic |
185| `OPENAI_API_KEY` | OpenAI |
186| `VERCEL_API_KEY` | Vercel AI Gateway |
187| `GEMINI_API_KEY` | Google Gemini |
188| `SYNTHETIC_API_KEY` | Synthetic |
189| `ZAI_API_KEY` | Z.ai |
190| `MINIMAX_API_KEY` | MiniMax |
191| `HF_TOKEN` | Hugging Face Inference |
192| `CEREBRAS_API_KEY` | Cerebras |
193| `OPENROUTER_API_KEY` | OpenRouter |
194| `IONET_API_KEY` | io.net |
195| `GROQ_API_KEY` | Groq |
196| `AVIAN_API_KEY` | Avian |
197| `OPENCODE_API_KEY` | OpenCode Zen & Go |
198| `VERTEXAI_PROJECT` | Google Cloud VertexAI (Gemini) |
199| `VERTEXAI_LOCATION` | Google Cloud VertexAI (Gemini) |
200| `AWS_ACCESS_KEY_ID` | Amazon Bedrock (Claude) |
201| `AWS_SECRET_ACCESS_KEY` | Amazon Bedrock (Claude) |
202| `AWS_REGION` | Amazon Bedrock (Claude) |
203| `AWS_PROFILE` | Amazon Bedrock (Custom Profile) |
204| `AWS_BEARER_TOKEN_BEDROCK` | Amazon Bedrock |
205| `AZURE_OPENAI_API_ENDPOINT` | Azure OpenAI models |
206| `AZURE_OPENAI_API_KEY` | Azure OpenAI models (optional when using Entra ID) |
207| `AZURE_OPENAI_API_VERSION` | Azure OpenAI models |
208
209### Subscriptions
210
211If you prefer subscription-based usage, here are some plans that work well in
212Crush:
213
214- [Synthetic](https://synthetic.new/pricing)
215- [GLM Coding Plan](https://z.ai/subscribe)
216- [Kimi Code](https://www.kimi.com/membership/pricing)
217- [MiniMax Coding Plan](https://platform.minimax.io/subscribe/coding-plan)
218
219### By the Way
220
221Is there a provider you’d like to see in Crush? Is there an existing model that needs an update?
222
223Crush’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.
224
225<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>
226
227## Configuration
228
229> [!TIP]
230> Crush ships with a builtin `crush-config` skill for configuring itself. In
231> many cases you can simply ask Crush to configure itself.
232
233Crush runs great with no configuration. That said, if you do need or want to
234customize Crush, configuration can be added either local to the project itself,
235or globally, with the following priority:
236
2371. `.crush.json`
2382. `crush.json`
2393. `$HOME/.config/crush/crush.json`
240
241Configuration itself is stored as a JSON object:
242
243```json
244{
245 "this-setting": { "this": "that" },
246 "that-setting": ["ceci", "cela"]
247}
248```
249
250As an additional note, Crush also stores ephemeral data, such as application
251state, in one additional location:
252
253```bash
254# Unix
255$HOME/.local/share/crush/crush.json
256
257# Windows
258%LOCALAPPDATA%\crush\crush.json
259```
260
261> [!TIP]
262> You can override the user and data config locations by setting:
263>
264> - `CRUSH_GLOBAL_CONFIG`
265> - `CRUSH_GLOBAL_DATA`
266
267### LSPs
268
269Crush can use LSPs for additional context to help inform its decisions, just
270like you would. LSPs can be added manually like so:
271
272```json
273{
274 "$schema": "https://charm.land/crush.json",
275 "lsp": {
276 "go": {
277 "command": "gopls",
278 "env": {
279 "GOTOOLCHAIN": "go1.24.5"
280 }
281 },
282 "typescript": {
283 "command": "typescript-language-server",
284 "args": ["--stdio"]
285 },
286 "nix": {
287 "command": "nil"
288 }
289 }
290}
291```
292
293### MCPs
294
295Crush also supports Model Context Protocol (MCP) servers through three
296transport types: `stdio` for command-line servers, `http` for HTTP endpoints,
297and `sse` for Server-Sent Events. Environment variable expansion is supported
298using `$(echo $VAR)` syntax.
299
300```json
301{
302 "$schema": "https://charm.land/crush.json",
303 "mcp": {
304 "filesystem": {
305 "type": "stdio",
306 "command": "node",
307 "args": ["/path/to/mcp-server.js"],
308 "timeout": 120,
309 "disabled": false,
310 "disabled_tools": ["some-tool-name"],
311 "env": {
312 "NODE_ENV": "production"
313 }
314 },
315 "github": {
316 "type": "http",
317 "url": "https://api.githubcopilot.com/mcp/",
318 "timeout": 120,
319 "disabled": false,
320 "disabled_tools": ["create_issue", "create_pull_request"],
321 "headers": {
322 "Authorization": "Bearer $GH_PAT"
323 }
324 },
325 "streaming-service": {
326 "type": "sse",
327 "url": "https://example.com/mcp/sse",
328 "timeout": 120,
329 "disabled": false,
330 "headers": {
331 "API-Key": "$(echo $API_KEY)"
332 }
333 }
334 }
335}
336```
337
338### Hooks
339
340Crush has preliminary support for hooks. For details, see
341[the hook guide](./docs/hooks/).
342
343### Ignoring Files
344
345Crush respects `.gitignore` files by default, but you can also create a
346`.crushignore` file to specify additional files and directories that Crush
347should ignore. This is useful for excluding files that you want in version
348control but don't want Crush to consider when providing context.
349
350The `.crushignore` file uses the same syntax as `.gitignore` and can be placed
351in the root of your project or in subdirectories.
352
353### Allowing Tools
354
355By default, Crush will ask you for permission before running tool calls. If
356you'd like, you can allow tools to be executed without prompting you for
357permissions. Use this with care.
358
359```json
360{
361 "$schema": "https://charm.land/crush.json",
362 "permissions": {
363 "allowed_tools": [
364 "view",
365 "ls",
366 "grep",
367 "edit",
368 "mcp_context7_get-library-doc"
369 ]
370 }
371}
372```
373
374You can also skip all permission prompts entirely by running Crush with the
375`--yolo` flag. Be very, very careful with this feature.
376
377### Disabling Built-In Tools
378
379If you'd like to prevent Crush from using certain built-in tools entirely, you
380can disable them via the `options.disabled_tools` list. Disabled tools are
381completely hidden from the agent.
382
383```json
384{
385 "$schema": "https://charm.land/crush.json",
386 "options": {
387 "disabled_tools": ["bash", "sourcegraph"]
388 }
389}
390```
391
392To disable tools from MCP servers, see the [MCP config section](#mcps).
393
394### Disabling Skills
395
396If you'd like to prevent Crush from using certain skills entirely, you can
397disable them via the `options.disabled_skills` list. Disabled skills are hidden
398from the agent, including builtin skills and skills discovered from disk.
399
400```json
401{
402 "$schema": "https://charm.land/crush.json",
403 "options": {
404 "disabled_skills": ["crush-config"]
405 }
406}
407```
408
409### Agent Skills
410
411Crush supports the [Agent Skills](https://agentskills.io) open standard for
412extending agent capabilities with reusable skill packages. Skills are folders
413containing a `SKILL.md` file with instructions that Crush can discover and
414activate on demand.
415
416The global paths we looks for skills are:
417
418* `$CRUSH_SKILLS_DIR`
419* `$XDG_CONFIG_HOME/agents/skills` or `~/.config/agents/skills/`
420* `$XDG_CONFIG_HOME/crush/skills` or `~/.config/crush/skills/`
421* On Windows, we _also_ look at
422 * `%LOCALAPPDATA%\agents\skills\` or `%USERPROFILE%\AppData\Local\agents\skills\`
423 * `%LOCALAPPDATA%\crush\skills\` or `%USERPROFILE%\AppData\Local\crush\skills\`
424* Additional paths configured via `options.skills_paths`
425
426On top of that, we _also_ load skills in your project from the following
427relative paths:
428
429* `.agents/skills`
430* `.crush/skills`
431* `.claude/skills`
432* `.cursor/skills`
433
434```jsonc
435{
436 "$schema": "https://charm.land/crush.json",
437 "options": {
438 "skills_paths": [
439 "~/.config/crush/skills", // Windows: "%LOCALAPPDATA%\\crush\\skills",
440 "./project-skills",
441 ],
442 },
443}
444```
445
446You can get started with example skills from [anthropics/skills](https://github.com/anthropics/skills):
447
448```bash
449# Unix
450mkdir -p ~/.config/crush/skills
451cd ~/.config/crush/skills
452git clone https://github.com/anthropics/skills.git _temp
453mv _temp/skills/* . && rm -rf _temp
454```
455
456```powershell
457# Windows (PowerShell)
458mkdir -Force "$env:LOCALAPPDATA\crush\skills"
459cd "$env:LOCALAPPDATA\crush\skills"
460git clone https://github.com/anthropics/skills.git _temp
461mv _temp/skills/* . ; rm -r -force _temp
462```
463
464### Desktop notifications
465
466Crush sends desktop notifications when a tool call requires permission and when
467the agent finishes its turn. They're only sent when the terminal window isn't
468focused _and_ your terminal supports reporting the focus state.
469
470```jsonc
471{
472 "$schema": "https://charm.land/crush.json",
473 "options": {
474 "disable_notifications": false, // default
475 },
476}
477```
478
479To disable desktop notifications, set `disable_notifications` to `true` in your
480configuration. On macOS, notifications currently lack icons due to platform
481limitations.
482
483### Initialization
484
485When you initialize a project, Crush analyzes your codebase and creates
486a context file that helps it work more effectively in future sessions.
487By default, this file is named `AGENTS.md`, but you can customize the
488name and location with the `initialize_as` option:
489
490```json
491{
492 "$schema": "https://charm.land/crush.json",
493 "options": {
494 "initialize_as": "AGENTS.md"
495 }
496}
497```
498
499This is useful if you prefer a different naming convention or want to
500place the file in a specific directory (e.g., `CRUSH.md` or
501`docs/LLMs.md`). Crush will fill the file with project-specific context
502like build commands, code patterns, and conventions it discovered during
503initialization.
504
505### Attribution Settings
506
507By default, Crush adds attribution information to Git commits and pull requests
508it creates. You can customize this behavior with the `attribution` option:
509
510```json
511{
512 "$schema": "https://charm.land/crush.json",
513 "options": {
514 "attribution": {
515 "trailer_style": "co-authored-by",
516 "generated_with": true
517 }
518 }
519}
520```
521
522- `trailer_style`: Controls the attribution trailer added to commit messages
523 (default: `assisted-by`)
524 - `assisted-by`: Adds `Assisted-by: [Model Name] via Crush <crush@charm.land>`
525 (includes the model name)
526 - `co-authored-by`: Adds `Co-Authored-By: Crush <crush@charm.land>`
527 - `none`: No attribution trailer
528- `generated_with`: When true (default), adds `💘 Generated with Crush` line to
529 commit messages and PR descriptions
530
531### Custom Providers
532
533Crush supports custom provider configurations for both OpenAI-compatible and
534Anthropic-compatible APIs.
535
536> [!NOTE]
537> Note that we support two "types" for OpenAI. Make sure to choose the right one
538> to ensure the best experience!
539>
540> - `openai` should be used when proxying or routing requests through OpenAI.
541> - `openai-compat` should be used when using non-OpenAI providers that have OpenAI-compatible APIs.
542
543#### OpenAI-Compatible APIs
544
545Here’s an example configuration for Deepseek, which uses an OpenAI-compatible
546API. Don't forget to set `DEEPSEEK_API_KEY` in your environment.
547
548```json
549{
550 "$schema": "https://charm.land/crush.json",
551 "providers": {
552 "deepseek": {
553 "type": "openai-compat",
554 "base_url": "https://api.deepseek.com/v1",
555 "api_key": "$DEEPSEEK_API_KEY",
556 "models": [
557 {
558 "id": "deepseek-chat",
559 "name": "Deepseek V3",
560 "cost_per_1m_in": 0.27,
561 "cost_per_1m_out": 1.1,
562 "cost_per_1m_in_cached": 0.07,
563 "cost_per_1m_out_cached": 1.1,
564 "context_window": 64000,
565 "default_max_tokens": 5000
566 }
567 ]
568 }
569 }
570}
571```
572
573#### Anthropic-Compatible APIs
574
575Custom Anthropic-compatible providers follow this format:
576
577```json
578{
579 "$schema": "https://charm.land/crush.json",
580 "providers": {
581 "custom-anthropic": {
582 "type": "anthropic",
583 "base_url": "https://api.anthropic.com/v1",
584 "api_key": "$ANTHROPIC_API_KEY",
585 "extra_headers": {
586 "anthropic-version": "2023-06-01"
587 },
588 "models": [
589 {
590 "id": "claude-sonnet-4-20250514",
591 "name": "Claude Sonnet 4",
592 "cost_per_1m_in": 3,
593 "cost_per_1m_out": 15,
594 "cost_per_1m_in_cached": 3.75,
595 "cost_per_1m_out_cached": 0.3,
596 "context_window": 200000,
597 "default_max_tokens": 50000,
598 "can_reason": true,
599 "supports_attachments": true
600 }
601 ]
602 }
603 }
604}
605```
606
607### Amazon Bedrock
608
609Crush currently supports running Anthropic models through Bedrock, with caching disabled.
610
611- A Bedrock provider will appear once you have AWS configured, i.e. `aws configure`
612- Crush also expects the `AWS_REGION` or `AWS_DEFAULT_REGION` to be set
613- To use a specific AWS profile set `AWS_PROFILE` in your environment, i.e. `AWS_PROFILE=myprofile crush`
614- Alternatively to `aws configure`, you can also just set `AWS_BEARER_TOKEN_BEDROCK`
615
616### Vertex AI Platform
617
618Vertex AI will appear in the list of available providers when `VERTEXAI_PROJECT` and `VERTEXAI_LOCATION` are set. You will also need to be authenticated:
619
620```bash
621gcloud auth application-default login
622```
623
624To add specific models to the configuration, configure as such:
625
626```json
627{
628 "$schema": "https://charm.land/crush.json",
629 "providers": {
630 "vertexai": {
631 "models": [
632 {
633 "id": "claude-sonnet-4@20250514",
634 "name": "VertexAI Sonnet 4",
635 "cost_per_1m_in": 3,
636 "cost_per_1m_out": 15,
637 "cost_per_1m_in_cached": 3.75,
638 "cost_per_1m_out_cached": 0.3,
639 "context_window": 200000,
640 "default_max_tokens": 50000,
641 "can_reason": true,
642 "supports_attachments": true
643 }
644 ]
645 }
646 }
647}
648```
649
650### Local Models
651
652Local models can also be configured via OpenAI-compatible API. Here are two common examples:
653
654#### Ollama
655
656```json
657{
658 "providers": {
659 "ollama": {
660 "name": "Ollama",
661 "base_url": "http://localhost:11434/v1/",
662 "type": "openai-compat",
663 "models": [
664 {
665 "name": "Qwen 3 30B",
666 "id": "qwen3:30b",
667 "context_window": 256000,
668 "default_max_tokens": 20000
669 }
670 ]
671 }
672 }
673}
674```
675
676#### LM Studio
677
678```json
679{
680 "providers": {
681 "lmstudio": {
682 "name": "LM Studio",
683 "base_url": "http://localhost:1234/v1/",
684 "type": "openai-compat",
685 "models": [
686 {
687 "name": "Qwen 3 30B",
688 "id": "qwen/qwen3-30b-a3b-2507",
689 "context_window": 256000,
690 "default_max_tokens": 20000
691 }
692 ]
693 }
694 }
695}
696```
697
698## Logging
699
700Sometimes you need to look at logs. Luckily, Crush logs all sorts of
701stuff. Logs are stored in `./.crush/logs/crush.log` relative to the project.
702
703The CLI also contains some helper commands to make perusing recent logs easier:
704
705```bash
706# Print the last 1000 lines
707crush logs
708
709# Print the last 500 lines
710crush logs --tail 500
711
712# Follow logs in real time
713crush logs --follow
714```
715
716Want more logging? Run `crush` with the `--debug` flag, or enable it in the
717config:
718
719```json
720{
721 "$schema": "https://charm.land/crush.json",
722 "options": {
723 "debug": true,
724 "debug_lsp": true
725 }
726}
727```
728
729## Provider Auto-Updates
730
731By default, Crush automatically checks for the latest and greatest list of
732providers and models from [Catwalk](https://github.com/charmbracelet/catwalk),
733the open source Crush provider database. This means that when new providers and
734models are available, or when model metadata changes, Crush automatically
735updates your local configuration.
736
737### Disabling automatic provider updates
738
739For those with restricted internet access, or those who prefer to work in
740air-gapped environments, this might not be want you want, and this feature can
741be disabled.
742
743To disable automatic provider updates, set `disable_provider_auto_update` into
744your `crush.json` config:
745
746```json
747{
748 "$schema": "https://charm.land/crush.json",
749 "options": {
750 "disable_provider_auto_update": true
751 }
752}
753```
754
755Or set the `CRUSH_DISABLE_PROVIDER_AUTO_UPDATE` environment variable:
756
757```bash
758export CRUSH_DISABLE_PROVIDER_AUTO_UPDATE=1
759```
760
761### Manually updating providers
762
763Manually updating providers is possible with the `crush update-providers`
764command:
765
766```bash
767# Update providers remotely from Catwalk.
768crush update-providers
769
770# Update providers from a custom Catwalk base URL.
771crush update-providers https://example.com/
772
773# Update providers from a local file.
774crush update-providers /path/to/local-providers.json
775
776# Reset providers to the embedded version, embedded at crush at build time.
777crush update-providers embedded
778
779# For more info:
780crush update-providers --help
781```
782
783## Metrics
784
785Crush records pseudonymous usage metrics (tied to a device-specific hash),
786which maintainers rely on to inform development and support priorities. The
787metrics include solely usage metadata; prompts and responses are NEVER
788collected.
789
790Details on exactly what’s collected are in the source code ([here](https://github.com/charmbracelet/crush/tree/main/internal/event)
791and [here](https://github.com/charmbracelet/crush/blob/main/internal/llm/agent/event.go)).
792
793You can opt out of metrics collection at any time by setting the environment
794variable by setting the following in your environment:
795
796```bash
797export CRUSH_DISABLE_METRICS=1
798```
799
800Or by setting the following in your config:
801
802```json
803{
804 "options": {
805 "disable_metrics": true
806 }
807}
808```
809
810Crush also respects the [`DO_NOT_TRACK`](https://donottrack.sh/) convention
811which can be enabled via `export DO_NOT_TRACK=1`.
812
813## Q&A
814
815### Why is clipboard copy and paste not working?
816
817Installing an extra tool might be needed on Unix-like environments.
818
819| Environment | Tool |
820| ------------------- | ------------------------ |
821| Windows | Native support |
822| macOS | Native support |
823| Linux/BSD + Wayland | `wl-copy` and `wl-paste` |
824| Linux/BSD + X11 | `xclip` or `xsel` |
825
826## Contributing
827
828See the [contributing guide](https://github.com/charmbracelet/crush?tab=contributing-ov-file#contributing).
829
830## Whatcha think?
831
832We’d love to hear your thoughts on this project. Need help? We gotchu. You can find us on:
833
834- [Twitter](https://twitter.com/charmcli)
835- [Slack][slack]
836- [Discord][discord]
837- [The Fediverse](https://mastodon.social/@charmcli)
838- [Bluesky](https://bsky.app/profile/charm.land)
839
840[slack]: https://charm.land/slack
841[discord]: https://charm.land/discord
842
843## License
844
845[FSL-1.1-MIT](https://github.com/charmbracelet/crush/raw/main/LICENSE.md)
846
847---
848
849Part of [Charm](https://charm.land).
850
851<a href="https://charm.land/"><img alt="The Charm logo" width="400" src="https://stuff.charm.sh/charm-banner-softy.jpg" /></a>
852
853<!--prettier-ignore-->
854Charm热爱开源 • Charm loves open source