git.iko.soy/crush
on main help sign in
docs(readme): add (very) basic getting started instuctions
fb0f172Christian Rocha
README.md+22
compare with main
unifiedsplit
@@ -10,6 +10,28 @@
10
10
11Crush is a tool for building software with AI.
11Crush is a tool for building software with AI.
12
12
13+## Getting Started
14+
15+For now, the quickest way to get started is to set an environment variable for
16+your preferred provider. Note that you can switch between providers mid-
17+sessions, so you're welcome to set environment variables for multiple
18+providers.
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+
13## License
35## License
14
36
15[MIT](https://github.com/charmbracelet/crush/raw/main/LICENSE)
37[MIT](https://github.com/charmbracelet/crush/raw/main/LICENSE)