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