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