1> [!WARNING]
  2> 🚧 This is a pre-release under heavy, active development. Things are still in flux but we’re excited to share early progress.
  3
  4# Crush
  5
  6<p>
  7    <a href="https://github.com/charmbracelet/crush/releases"><img src="https://img.shields.io/github/release/charmbracelet/crush" alt="Latest Release"></a>
  8    <a href="https://github.com/charmbracelet/crush/actions"><img src="https://github.com/charmbracelet/crush/workflows/build/badge.svg" alt="Build Status"></a>
  9</p>
 10
 11Crush is a tool for building software with AI.
 12
 13## Installation
 14
 15Nightly builds are available while Crush is in development.
 16
 17- [Packages](https://github.com/charmbracelet/crush/releases/tag/nightly) are available in Debian and RPM formats
 18- [Binaries](https://github.com/charmbracelet/crush/releases/tag/nightly) are available for Linux and macOS
 19
 20You can also just install it with go:
 21
 22```
 23git clone git@github.com:charmbracelet/crush.git
 24cd crush
 25go install
 26```
 27
 28Note that Crush doesn't support Windows yet, however Windows support is planned and in progress.
 29
 30## Getting Started
 31
 32For now, the quickest way to get started is to set an environment variable for
 33your preferred provider. Note that you can switch between providers mid-
 34sessions, so you're welcome to set environment variables for multiple
 35providers.
 36
 37| Environment Variable       | Provider                                           |
 38| -------------------------- | -------------------------------------------------- |
 39| `ANTHROPIC_API_KEY`        | Anthropic                                          |
 40| `OPENAI_API_KEY`           | OpenAI                                             |
 41| `GEMINI_API_KEY`           | Google Gemini                                      |
 42| `VERTEXAI_PROJECT`         | Google Cloud VertexAI (Gemini)                     |
 43| `VERTEXAI_LOCATION`        | Google Cloud VertexAI (Gemini)                     |
 44| `GROQ_API_KEY`             | Groq                                               |
 45| `AWS_ACCESS_KEY_ID`        | AWS Bedrock (Claude)                               |
 46| `AWS_SECRET_ACCESS_KEY`    | AWS Bedrock (Claude)                               |
 47| `AWS_REGION`               | AWS Bedrock (Claude)                               |
 48| `AZURE_OPENAI_ENDPOINT`    | Azure OpenAI models                                |
 49| `AZURE_OPENAI_API_KEY`     | Azure OpenAI models (optional when using Entra ID) |
 50| `AZURE_OPENAI_API_VERSION` | Azure OpenAI models                                |
 51
 52## Configuration
 53
 54For many use cases, Crush can be run with no config. That said, if you do need config, it can be added either local to the project itself, or globally. Configuration has the following priority:
 55
 561. `.crush.json`
 572. `crush.json`
 583. `$HOME/.config/crush/crush.json`
 59
 60### LSPs
 61
 62Crush can use LSPs for additional context to help inform its decisions, just like you would. LSPs can be added manually like so:
 63
 64```json
 65{
 66  "lsp": {
 67    "go": {
 68      "command": "gopls"
 69    },
 70    "typescript": {
 71      "command": "typescript-language-server",
 72      "args": ["--stdio"]
 73    },
 74    "nix": {
 75      "command": "alejandra"
 76    }
 77  }
 78}
 79```
 80
 81### MCPs
 82
 83Crush can also use MCPs for additional context. Add LSPs to the config like so:
 84
 85```
 86{
 87  "mcp": {
 88    "context7": {
 89      "command": "",
 90      "url": "https://mcp.context7.com/mcp",
 91      "type": "http"
 92    }
 93  },
 94}
 95```
 96
 97### OpenAI-Compatible APIs
 98
 99Crush supports all OpenAI-compatible APIs. Here's an example configuration for Deepseek, which uses an OpenAI-compatible API. Don't forget to set `DEEPSEEK_API_KEY` in your environment.
100
101```json
102{
103  "providers": {
104    "deepseek": {
105      "provider_type": "openai",
106      "base_url": "https://api.deepseek.com/v1",
107      "models": [
108        {
109          "id": "deepseek-chat",
110          "model": "Deepseek V3",
111          "cost_per_1m_in": 0.27,
112          "cost_per_1m_out": 1.1,
113          "cost_per_1m_in_cached": 0.07,
114          "cost_per_1m_out_cached": 1.1,
115          "context_window": 64000,
116          "default_max_tokens": 5000
117        }
118      ]
119    }
120  }
121}
122```
123
124## Whatcha think?
125
126We’d love to hear your thoughts on this project. Feel free to drop us a note!
127
128- [Twitter](https://twitter.com/charmcli)
129- [The Fediverse](https://mastodon.social/@charmcli)
130- [Discord](https://charm.sh/chat)
131
132## License
133
134[MIT](https://github.com/charmbracelet/crush/raw/main/LICENSE)
135
136---
137
138Part of [Charm](https://charm.land).
139
140<a href="https://charm.sh/"><img alt="The Charm logo" width="400" src="https://stuff.charm.sh/charm-banner-next.jpg" /></a>
141
142<!--prettier-ignore-->
143Charm热爱开源 • Charm loves open source