Skip to content

crush-tutorial

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

crush-tutorial

README.md

layout title nav_order has_children format_version
default
Crush Tutorial
122
true
v2

Crush Tutorial: Multi-Model Terminal Coding Agent with Strong Extensibility

Learn how to use charmbracelet/crush for terminal-native coding workflows with flexible model providers, LSP/MCP integrations, and production-grade controls.

GitHub Repo License Docs

Why This Track Matters

Crush is one of the fastest-growing terminal coding agents and is designed around practical developer loops: model flexibility, project sessions, local config control, and advanced integrations.

This track focuses on:

  • installing and configuring Crush for immediate coding work
  • controlling providers, permissions, and tool behavior safely
  • integrating LSP and MCP for richer code intelligence
  • standardizing Crush usage across team environments

Current Snapshot (auto-updated)

Mental Model

flowchart LR
    A[Developer Prompt] --> B[Crush Session]
    B --> C[Provider and Model Router]
    C --> D[Tool Calls LSP/MCP/Built-in]
    D --> E[File and Command Effects]
    E --> F[Review, Iterate, Commit]
Loading

Chapter Guide

Chapter Key Question Outcome
01 - Getting Started How do I install and run Crush fast? Working baseline
02 - Architecture and Session Model How does Crush manage project and session state? Runtime mental model
03 - Providers and Model Configuration How do I configure providers and models robustly? Stable provider strategy
04 - Permissions and Tool Controls How do I enforce safe tool execution boundaries? Safer execution model
05 - LSP and MCP Integration How do I plug in language servers and MCP tools? Extended capabilities
06 - Skills, Commands, and Workflow Customization How do I tailor Crush to team and project conventions? Reusable workflow system
07 - Logs, Debugging, and Operations How do I diagnose and maintain Crush at scale? Operational confidence
08 - Production Governance and Rollout How do teams adopt Crush safely in production repos? Governance runbook

What You Will Learn

  • how to configure Crush for consistent coding-agent performance
  • how to manage provider routing and custom model definitions
  • how to extend Crush with LSP, MCP, skills, and custom commands
  • how to operate Crush with robust production controls

Source References

Related Tutorials

Start with Chapter 1: Getting Started.

Navigation & Backlinks

Full Chapter Map

  1. Chapter 1: Getting Started
  2. Chapter 2: Architecture and Session Model
  3. Chapter 3: Providers and Model Configuration
  4. Chapter 4: Permissions and Tool Controls
  5. Chapter 5: LSP and MCP Integration
  6. Chapter 6: Skills, Commands, and Workflow Customization
  7. Chapter 7: Logs, Debugging, and Operations
  8. Chapter 8: Production Governance and Rollout

Generated by AI Codebase Knowledge Builder