diff --git a/README.md b/README.md index aedd503e42ed3564627a891d41d8874740c1ea3c..e89c651de360e0bcfa0336f4a726b60ea9635d31 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@

Your new coding bestie, now available in your favourite terminal.
Your tools, your code, and your workflows, wired into your LLM of choice.

+

你的新编程伙伴,现在就在你最爱的终端中。
你的工具、代码和工作流,都与您选择的 LLM 模型紧密相连。

Crush Demo

@@ -66,7 +67,7 @@ nix-shell -p '(import { pkgs = import {}; }).repos.charmbracelet ### NixOS & Home Manager Module Usage via NUR -Crush provides NixOS and Home Manager modules via NUR. +Crush provides NixOS and Home Manager modules via NUR. You 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 :) ```nix @@ -121,7 +122,6 @@ You can use these modules directly in your flake by importing them from NUR. Sin -
Debian/Ubuntu @@ -175,22 +175,22 @@ Crush. You'll be prompted to enter your API key. That said, you can also set environment variables for preferred providers. -| Environment Variable | Provider | -| -------------------------- | -------------------------------------------------- | -| `ANTHROPIC_API_KEY` | Anthropic | -| `OPENAI_API_KEY` | OpenAI | -| `OPENROUTER_API_KEY` | OpenRouter | -| `CEREBRAS_API_KEY` | Cerebras | -| `GEMINI_API_KEY` | Google Gemini | -| `VERTEXAI_PROJECT` | Google Cloud VertexAI (Gemini) | -| `VERTEXAI_LOCATION` | Google Cloud VertexAI (Gemini) | -| `GROQ_API_KEY` | Groq | -| `AWS_ACCESS_KEY_ID` | AWS Bedrock (Claude) | -| `AWS_SECRET_ACCESS_KEY` | AWS Bedrock (Claude) | -| `AWS_REGION` | AWS Bedrock (Claude) | -| `AZURE_OPENAI_API_ENDPOINT`| Azure OpenAI models | -| `AZURE_OPENAI_API_KEY` | Azure OpenAI models (optional when using Entra ID) | -| `AZURE_OPENAI_API_VERSION` | Azure OpenAI models | +| Environment Variable | Provider | +| --------------------------- | -------------------------------------------------- | +| `ANTHROPIC_API_KEY` | Anthropic | +| `OPENAI_API_KEY` | OpenAI | +| `OPENROUTER_API_KEY` | OpenRouter | +| `CEREBRAS_API_KEY` | Cerebras | +| `GEMINI_API_KEY` | Google Gemini | +| `VERTEXAI_PROJECT` | Google Cloud VertexAI (Gemini) | +| `VERTEXAI_LOCATION` | Google Cloud VertexAI (Gemini) | +| `GROQ_API_KEY` | Groq | +| `AWS_ACCESS_KEY_ID` | AWS Bedrock (Claude) | +| `AWS_SECRET_ACCESS_KEY` | AWS Bedrock (Claude) | +| `AWS_REGION` | AWS Bedrock (Claude) | +| `AZURE_OPENAI_API_ENDPOINT` | Azure OpenAI models | +| `AZURE_OPENAI_API_KEY` | Azure OpenAI models (optional when using Entra ID) | +| `AZURE_OPENAI_API_VERSION` | Azure OpenAI models | ### By the Way