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## Getting Started
14
15For now, the quickest way to get started is to set an environment variable for
16your preferred provider. Note that you can switch between providers mid-
17sessions, so you're welcome to set environment variables for multiple
18providers.
19
20| Environment Variable | Provider |
21| -------------------------- | -------------------------------------------------- |
22| `ANTHROPIC_API_KEY` | Anthropic |
23| `OPENAI_API_KEY` | OpenAI |
24| `GEMINI_API_KEY` | Google Gemini |
25| `VERTEXAI_PROJECT` | Google Cloud VertexAI (Gemini) |
26| `VERTEXAI_LOCATION` | Google Cloud VertexAI (Gemini) |
27| `GROQ_API_KEY` | Groq |
28| `AWS_ACCESS_KEY_ID` | AWS Bedrock (Claude) |
29| `AWS_SECRET_ACCESS_KEY` | AWS Bedrock (Claude) |
30| `AWS_REGION` | AWS Bedrock (Claude) |
31| `AZURE_OPENAI_ENDPOINT` | Azure OpenAI models |
32| `AZURE_OPENAI_API_KEY` | Azure OpenAI models (optional when using Entra ID) |
33| `AZURE_OPENAI_API_VERSION` | Azure OpenAI models |
34
35## License
36
37[MIT](https://github.com/charmbracelet/crush/raw/main/LICENSE)
38
39---
40
41Part of [Charm](https://charm.sh).
42
43<a href="https://charm.sh/"><img alt="The Charm logo" width="400" src="https://stuff.charm.sh/charm-badge.jpg" /></a>
44
45<!--prettier-ignore-->
46Charm热爱开源 • Charm loves open source