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
15* [Packages](https://github.com/charmbracelet/crush/releases/tag/nightly) are available in Debian and RPM formats
16* [Binaries](https://github.com/charmbracelet/crush/releases/tag/nightly) are available for Linux and macOS
17
18Or just install it with go:
19
20```
21git clone git@github.com:charmbracelet/crush.git
22cd crush
23go install
24```
25
26## Getting Started
27
28For now, the quickest way to get started is to set an environment variable for
29your preferred provider. Note that you can switch between providers mid-
30sessions, so you're welcome to set environment variables for multiple
31providers.
32
33| Environment Variable | Provider |
34| -------------------------- | -------------------------------------------------- |
35| `ANTHROPIC_API_KEY` | Anthropic |
36| `OPENAI_API_KEY` | OpenAI |
37| `GEMINI_API_KEY` | Google Gemini |
38| `VERTEXAI_PROJECT` | Google Cloud VertexAI (Gemini) |
39| `VERTEXAI_LOCATION` | Google Cloud VertexAI (Gemini) |
40| `GROQ_API_KEY` | Groq |
41| `AWS_ACCESS_KEY_ID` | AWS Bedrock (Claude) |
42| `AWS_SECRET_ACCESS_KEY` | AWS Bedrock (Claude) |
43| `AWS_REGION` | AWS Bedrock (Claude) |
44| `AZURE_OPENAI_ENDPOINT` | Azure OpenAI models |
45| `AZURE_OPENAI_API_KEY` | Azure OpenAI models (optional when using Entra ID) |
46| `AZURE_OPENAI_API_VERSION` | Azure OpenAI models |
47| `LLAMA_API_KEY` | Llama API |
48
49## License
50
51[MIT](https://github.com/charmbracelet/crush/raw/main/LICENSE)
52
53---
54
55Part of [Charm](https://charm.sh).
56
57<a href="https://charm.sh/"><img alt="The Charm logo" width="400" src="https://stuff.charm.sh/charm-banner-next.jpg" /></a>
58
59<!--prettier-ignore-->
60Charm热爱开源 • Charm loves open source