charmbracelet/crush
crush
Glamourous agentic coding for all ๐
Usage guide
crush is an open-source project around agentic-ai, llms, ravishing with 25,826 GitHub stars. This guide focuses on when to use it, how to install it, how to run the first example, and what to verify before adopting it.
Key features
- Implemented mainly in Go, useful for judging integration effort in a similar stack.
- GitHub did not detect a repository license, so commercial permission is unconfirmed. Review the repository terms and any model weights, datasets, dependencies, or external services before commercial adoption.
- GitHub is the main evaluation surface; review the README, issues, and recent commits first.
Best for
- Evaluating crush for Go AI workflows.
- Comparing a GitHub project with 25,826 stars and current repository activity.
Pros
- crush has visible GitHub traction with 25,826 stars. Topics: agentic-ai, ai, llms.
- The GitHub repository is the primary evaluation surface.
Cons
- Production fit still depends on documentation depth, issue activity, and release cadence.
- No license was detected, so usage risk needs manual review.
Production readiness
crush should be validated with its README, release history, open issues, and integration requirements before production use.
License risk
GitHub did not report a license, which usually requires manual legal review before production use.
crush architecture preview
crush's main path starts at the entry surface, runs through Coding agent runtime, combines Optional AI model, Runtime context, GitHub / Shell commands, and returns User-facing result.
Entry
CLI / terminal entry
crush is primarily entered through a developer command or terminal workflow.
brew install charmbracelet/tap/crush
Runtime
Coding agent runtime
The runtime reads developer intent, inspects repository context, plans edits, and returns code-oriented actions.
coding workflow
Model
Optional AI model
The project connects its core runtime to local models or hosted AI APIs when model inference is required.
model signal
Context
Runtime context
Runtime state, user input, repository files, or configuration provide context for each task.
context signal
Tools
GitHub / Shell commands
Tool adapters let the runtime act outside the model through GitHub / Shell commands.
GitHub, Shell commands
Output
User-facing result
The final output is returned to the user, workflow, API caller, or downstream system.
output
Featured video
Mariano Razo
Haz esto para que tu CRUSH te haga caso!๐๐๐คค
82,324,175 views ยท 2023-09-21
Install tutorial
Before you install
- Node.js and the package manager used by the project
- Local build tools for compiling the project
- A clean working directory for the first test run
Check the runtime environment
crush may require a local build toolchain. Check the compiler, package manager, and system dependencies first.
Get the project files
Start from the official repository or package so the first run matches the documented behavior.
$ git clone https://github.com/charmbracelet/crush.gitInstall or build dependencies
Run the next setup command detected from the project documentation.
$ brew install charmbracelet/tap/crushAdoption guidance and sources
Practical use cases
Glamourous agentic coding for all ๐
This is one of the documented reasons to evaluate crush before choosing a stack.
Focus area: agentic-ai
This is one of the documented reasons to evaluate crush before choosing a stack.
All project comparison
Compare crush with similar projects before committing to a stack.
Before adopting
- Complete one clean-environment verification using the official crush setup path.
- Review repository license, model weights, external services, and dependency terms for your use case.
- Check recent commits, release cadence, issue response, and documentation depth.
- Evaluate output quality, latency, resource usage, and recovery behavior with a small dataset.
Configuration notes
- Review README configuration notes before using production data.
Sources checked
These links are used to verify repository, documentation, or tutorial details. Review the source pages before adopting the project.
Troubleshooting
- If installation fails, first confirm the command is being run from the README-specified directory.
- If dependencies conflict, retry in a fresh virtual environment, container, or working directory.
- If output looks wrong, return to the smallest documented crush example before adding complex data.
- For keys, model files, or external services, verify environment variables, local paths, and permissions one by one.
- Before production use, review recent updates, open issues, license terms, and safety boundaries.
What is crush?
crush is an open-source all project. Glamourous agentic coding for all ๐
How do I install crush?
Start with the official README. The first detected setup step is: git clone https://github.com/charmbracelet/crush.git.
Is crush beginner-friendly?
If you already know the Go ecosystem, start with the smallest example. Otherwise test it in an isolated environment first.
Can crush be used commercially?
GitHub did not detect a repository license, so commercial permission is unconfirmed. Review the repository terms and any model weights, datasets, dependencies, or external services before commercial adoption.
Does crush need a GPU?
GPU requirements depend on the workload, model, and dataset size. Start with the smallest README example before scaling up.
How should I decide whether to adopt crush?
Evaluate setup cost, maintenance activity, issue health, license terms, and fit with your real workflow.