git.iko.soy/crush
on main help sign in
docs(readme): add mini Chinese description (thanks @ohjia)
976425cChristian Rocha
README.md+18−18
compare with main
unifiedsplit
@@ -7,6 +7,7 @@
7</p>
7</p>
8
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>
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>
10
11
11<p align="center"><img width="800" alt="Crush Demo" src="https://github.com/user-attachments/assets/58280caf-851b-470a-b6f7-d5c4ea8a1968" /></p>
12<p align="center"><img width="800" alt="Crush Demo" src="https://github.com/user-attachments/assets/58280caf-851b-470a-b6f7-d5c4ea8a1968" /></p>
12
13
@@ -66,7 +67,7 @@ nix-shell -p '(import <nur> { pkgs = import <nixpkgs> {}; }).repos.charmbracelet
66
67
67### NixOS & Home Manager Module Usage via NUR
68### NixOS & Home Manager Module Usage via NUR
68
69
69−Crush provides NixOS and Home Manager modules via NUR.
70+Crush provides NixOS and Home Manager modules via NUR.
70You 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 :)
71You can use these modules directly in your flake by importing them from NUR. Since it auto detects whether its a home manager or nixos context you can use the import the exact same way :)
71
72
72```nix
73```nix
@@ -121,7 +122,6 @@ You can use these modules directly in your flake by importing them from NUR. Sin
121
122
122</details>
123</details>
123
124
124−
125<details>
125<details>
126<summary><strong>Debian/Ubuntu</strong></summary>
126<summary><strong>Debian/Ubuntu</strong></summary>
127
127
@@ -175,22 +175,22 @@ Crush. You'll be prompted to enter your API key.
175
175
176That said, you can also set environment variables for preferred providers.
176That said, you can also set environment variables for preferred providers.
177
177
178−| Environment Variable | Provider |
178+| Environment Variable | Provider |
179−| -------------------------- | -------------------------------------------------- |
179+| --------------------------- | -------------------------------------------------- |
180−| `ANTHROPIC_API_KEY` | Anthropic |
180+| `ANTHROPIC_API_KEY` | Anthropic |
181−| `OPENAI_API_KEY` | OpenAI |
181+| `OPENAI_API_KEY` | OpenAI |
182−| `OPENROUTER_API_KEY` | OpenRouter |
182+| `OPENROUTER_API_KEY` | OpenRouter |
183−| `CEREBRAS_API_KEY` | Cerebras |
183+| `CEREBRAS_API_KEY` | Cerebras |
184−| `GEMINI_API_KEY` | Google Gemini |
184+| `GEMINI_API_KEY` | Google Gemini |
185−| `VERTEXAI_PROJECT` | Google Cloud VertexAI (Gemini) |
185+| `VERTEXAI_PROJECT` | Google Cloud VertexAI (Gemini) |
186−| `VERTEXAI_LOCATION` | Google Cloud VertexAI (Gemini) |
186+| `VERTEXAI_LOCATION` | Google Cloud VertexAI (Gemini) |
187−| `GROQ_API_KEY` | Groq |
187+| `GROQ_API_KEY` | Groq |
188−| `AWS_ACCESS_KEY_ID` | AWS Bedrock (Claude) |
188+| `AWS_ACCESS_KEY_ID` | AWS Bedrock (Claude) |
189−| `AWS_SECRET_ACCESS_KEY` | AWS Bedrock (Claude) |
189+| `AWS_SECRET_ACCESS_KEY` | AWS Bedrock (Claude) |
190−| `AWS_REGION` | AWS Bedrock (Claude) |
190+| `AWS_REGION` | AWS Bedrock (Claude) |
191−| `AZURE_OPENAI_API_ENDPOINT`| Azure OpenAI models |
191+| `AZURE_OPENAI_API_ENDPOINT` | Azure OpenAI models |
192−| `AZURE_OPENAI_API_KEY` | Azure OpenAI models (optional when using Entra ID) |
192+| `AZURE_OPENAI_API_KEY` | Azure OpenAI models (optional when using Entra ID) |
193−| `AZURE_OPENAI_API_VERSION` | Azure OpenAI models |
193+| `AZURE_OPENAI_API_VERSION` | Azure OpenAI models |
194
194
195### By the Way
195### By the Way
196
196