crush is an AI-driven tool developed by Charm that provides context-aware suggestions and code explanations, integrating with Language Server Protocol (LSP) for a smooth developer experience.
When to Activate
- When the user wants interactive AI assistance for code analysis.
- When performing fast diagnostics or seeking intelligent suggestions within a project.
- When running single, non-interactive AI prompts for code explanation.
- When the user needs a debugged or YOLO-approved execution of AI commands.
Core Principles & Rules
- API Key Inheritance: Inherits
OPENAI_API_KEYandGEMINI_API_KEYfromx openaiandx geminiconfigurations. - Context Awareness: Best used within a specific project directory (
--cwd) to leverage local code context. - YOLO Mode: Use
-yor--yoloto automatically accept permissions for high-speed interaction.
Additional Scenarios
- Non-Interactive Prompts: Use the
runsubcommand for quick queries. - Debugging: Enable detailed logs with
-dfor troubleshooting AI interactions.
Patterns & Examples
Interactive Session
# Start an interactive AI session for the current project
x crush
Non-Interactive Query
# Ask for a quick code explanation
x crush run "Explain the use of context in Go"
Sandboxed/CWD Execution
# Run crush in a specific project directory with debug logging
x crush -d -c /path/to/project
Checklist
- Ensure relevant AI API keys (OpenAI/Gemini) are set up via their respective x-cmd modules.
- Verify the target directory if using the
--cwdflag. - Confirm if YOLO mode is appropriate for the current task safety.