README.md · crush · git.iko.soy

git.iko.soy/crush

crush/README.md

127 lines 4.4 kB history raw

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.

4# Crush

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>

11Crush is a tool for building software with AI.

13## Installation

15Nightly builds are available while Crush is in development.

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

20You can also just install it with go:

22```

23git clone git@github.com:charmbracelet/crush.git

24cd crush

25go install

26```

28Note that Crush doesn't support Windows yet, however Windows support is planned and in progress.

30## Getting Started

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.

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 |

52## Configuration

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:

561. `.crush.json`

572. `crush.json`

583. `$HOME/.config/crush/crush.json`

60### LSPs

62Crush can use LSPs for additional context to help inform its decisions, just like you would. LSPs can be added manually like so:

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```

81### OpenAI-Compatible APIs

83Crush 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.

85```json

86{

87 "providers": {

88 "deepseek": {

89 "provider_type": "openai",

90 "base_url": "https://api.deepseek.com/v1",

91 "models": [

92 {

93 "id": "deepseek-chat",

94 "model": "Deepseek V3",

95 "cost_per_1m_in": 0.27,

96 "cost_per_1m_out": 1.1,