Introduction
Your new coding bestie, now available in your favourite terminal. Your tools, your code, and your workflows, wired into your LLM of choice.
Why Crush?
Crush is your terminal-based coding companion, integrating large language models (LLMs) directly into your workflow. Whether you’re coding, debugging, or managing projects, Crush connects your tools and code to your chosen LLM, offering a flexible, context-aware experience right in your terminal.
Use Crush with Lip Gloss or Bubble Tea to create styled, interactive terminal apps powered by LLMs.
Key Concepts
Crush simplifies LLM integration in the terminal:
Choose from multiple LLMs or add custom ones via OpenAI- or Anthropic-compatible APIs, seamlessly integrating AI into your coding workflow.
Maintain multiple work sessions per project, preserving context as you switch between LLMs or tasks.
Extend Crush’s capabilities with modular plugins (MCPs) using HTTP, stdio, or SSE protocols for custom functionality.
Key Features
Multi-Model
Choose from a wide range of LLMs or add your own via OpenAI- or Anthropic-compatible APIs.
Flexible
Switch LLMs mid-session while preserving context.
Session-Based
Maintain multiple work sessions and contexts per project.
LSP-Enhanced
Crush uses LSPs for additional context, just like you do.
Extensible
Add capabilities via MCPs (http, stdio, and sse).
Works Everywhere
First-class support in every terminal on macOS, Linux, Windows (PowerShell and WSL), FreeBSD, OpenBSD, and NetBSD.
Get Started
Ready to code with Crush? Follow this step:
Explore Crush
Visit the Crush GitHub page to install and start integrating LLMs into your terminal workflow.
Crush CheatSheet
Explore CheatSheet to explore all crush cli cmds and session commands.
Getting Started
Read This before you start and here you go!
What’s Next?
Dive into Crush with these resources:
- Crush GitHub: Explore the repository for codebase of crush.
- Community Discussions: Share ideas or ask questions in the Charmbracelet community.
- Lip Gloss Docs: Style your Crush interfaces with Lip Gloss.
- Bubble Tea Docs: Build interactive TUIs with Bubble Tea and Crush.
How is this guide?