🚀 Broke CLI - Ultimate Coding Assistant

The most powerful CLI coding assistant
Code, fix, debug, and create with AI at your fingertips

✨ Features

• 🎯 Smart Code Analysis - Analyze and understand your codebase
• 🔧 Auto-Fix - Automatically fix bugs and issues
• 📝 Code Generation - Generate code from natural language descriptions
• 🐛 Debug Assistant - Get help debugging complex issues
• 🎨 Beautiful Terminal UI - Rich colors, animations, and modern design
• 📊 Real-time Logs - Colored, structured logging with multiple levels
• 🌐 AI Integration - Lightning-fast AI responses
• 📁 File Context - Understand your project structure
• 🔍 Smart Search - Find and analyze code patterns
• 📚 Documentation - Generate and improve documentation

🚀 Quick Start

Installation

# Clone the repository
git clone https://github.com/your-username/broke-cli.git
cd broke-cli

# Install dependencies
npm install

# Build the project
npm run build

# Set up environment variables
cp env.example .env
# Edit .env with your API key

# Install globally (optional)
npm link

Basic Usage

# Interactive mode
broke

# Direct command
broke "Fix the authentication bug in user.js"

# Analyze specific file
broke analyze src/components/User.js

# Generate new component
broke generate "Create a React component for user profile"

# Fix issues
broke fix "Fix all TypeScript errors"

🎯 Commands

Core Commands

• broke - Interactive mode
• broke <prompt> - Direct AI interaction
• broke analyze <file> - Analyze specific file
• broke generate <description> - Generate code
• broke fix <issue> - Fix code issues
• broke debug <problem> - Debug assistance
• broke docs <file> - Generate documentation

Utility Commands

• broke config - Configure settings
• broke logs - View logs
• broke version - Show version
• broke help - Show help

🔧 Configuration

Environment Variables

API_KEY=your_api_key_here
BROKE_CLI_THEME=default
BROKE_CLI_LOG_LEVEL=info
BROKE_CLI_MODEL=qwen/qwen3-32b

Themes

• default - Classic terminal look
• dark - Dark theme
• colorful - Vibrant colors
• minimal - Clean and simple

📁 Project Structure

broke-cli/
├── src/
│   ├── commands/          # CLI commands
│   ├── services/          # Core services
│   ├── utils/             # Utility functions
│   ├── types/             # TypeScript types
│   └── index.ts           # Main entry point
├── dist/                  # Compiled output
├── package.json           # Dependencies
├── tsconfig.json          # TypeScript config
└── README.md             # This file

🎨 UI Features

• Gradient Headers - Beautiful ASCII art with gradients
• Colored Output - Syntax highlighting for code
• Progress Indicators - Spinners and progress bars
• Interactive Prompts - User-friendly input forms
• Rich Logging - Structured, colored log output
• Responsive Design - Adapts to terminal size

🔌 API Integration

Broke CLI integrates with AI APIs for lightning-fast responses:

• Model: qwen/qwen3-32b (default)
• Endpoint: OpenAI-compatible API
• Rate Limiting: Built-in request management
• Error Handling: Graceful fallbacks and retries

🚀 Advanced Usage

Code Analysis

# Analyze entire project
broke analyze .

# Analyze specific patterns
broke analyze "Find all async functions"

# Performance analysis
broke analyze "Identify performance bottlenecks"

Code Generation

# Generate React component
broke generate "Create a responsive navigation bar"

# Generate API endpoint
broke generate "Create Express.js user CRUD endpoints"

# Generate tests
broke generate "Write unit tests for UserService"

Debugging

# Debug specific error
broke debug "TypeError: Cannot read property 'name' of undefined"

# Debug performance issue
broke debug "Why is my app slow on mobile?"

# Debug build issues
broke debug "Webpack build failing with module not found"

🛠️ Development

Prerequisites

• Node.js >= 18.0.0
• npm or yarn
• TypeScript knowledge

Development Commands

# Install dependencies
npm install

# Development mode
npm run dev

# Build project
npm run build

# Clean build
npm run clean

# Run tests (when implemented)
npm test

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• AI APIs for intelligent assistance
• Commander.js for CLI framework
• Chalk for terminal colors
• Inquirer for interactive prompts

📞 Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Email: support@broke-cli.com

Made with ❤️ by the Broke CLI Team