CodeBuddy is a revolutionary Visual Studio Code extension that transforms your development workflow with AI-powered assistance. From intelligent code completion to comprehensive documentation generation, CodeBuddy is your complete development companion.
🚀 Context-Aware Code Completion - Get Copilot-style inline suggestions based on your codebase patterns
📚 Intelligent Documentation Generator - Auto-generate comprehensive project documentation
🔍 Advanced Codebase Understanding - Deep architectural analysis with RAG capabilities
🤖 AI Agent Orchestration - Multi-agent system for complex development tasks
💡 Real-time Code Analysis - Instant feedback and suggestions as you code
- Multiple AI Models: Choose from Gemini, Anthropic Claude, Groq, Deepseek, and XGrok
- Intelligent Code Review: Deep analysis of code quality, security, and best practices
- Smart Refactoring: Context-aware code improvements and restructuring
- Performance Optimization: AI-driven suggestions for better performance
- Bug Detection & Fixes: Automatic error detection with intelligent fix suggestions
- Inline Suggestions: Copilot-style grey text completions as you type
- Pattern Learning: Learns from your codebase to suggest relevant completions
- Function Signatures: Smart parameter suggestions based on your patterns
- Variable Naming: Intelligent variable name suggestions following your conventions
- Block Completion: Auto-completes common code structures (if/for/try blocks)
- Comprehensive README: Auto-generates professional README.md files
- API Documentation: Extracts and documents REST endpoints automatically
- Architecture Analysis: Creates Mermaid diagrams and architectural overviews
- Component Documentation: Documents classes, interfaces, and modules
- Smart Analysis: Understands project structure and generates relevant docs
- RAG-Powered Analysis: Retrieval-Augmented Generation for accurate codebase insights
- Architectural Recommendations: Suggests improvements based on your project structure
- Framework Detection: Identifies and analyzes technologies in use
- Pattern Recognition: Understands your coding patterns and conventions
- Context-Aware Q&A: Answer questions about your specific codebase
- Modern React UI: Beautiful, responsive chat interface
- Code Context: Automatic code context inclusion in conversations
- File Upload: Support for various file formats (PDF, DOCX, CSV, JSON, TXT)
- Syntax Highlighting: Code blocks with proper language detection
- Customizable Themes: Multiple chat themes to match your preferences
- Open VS Code
- Go to Extensions (Ctrl+Shift+X)
- Search for "CodeBuddy"
- Click Install
- Select AI Model: Choose your preferred AI provider in VS Code settings
- Add API Key: Configure your API key for the chosen model
- Start Coding: CodeBuddy is now ready to assist!
- Gemini: Get API Key
- Anthropic: Get API Key
- Groq: Get API Key
- Deepseek: Get API Key
- XGrok: Get API Key
Right-click on selected code to access these features:
- 💭 Add Comments - Intelligent code documentation
- 🔍 Review Code - Comprehensive code analysis
- 🔄 Refactor Code - Smart code improvements
- ⚡ Optimize Code - Performance enhancements
- 💬 Explain Code - Clear explanations of complex logic
- 📝 Generate Commit Message - Smart Git commit messages
- 💫 Inline Chat - Context-aware code discussions
- 📚 Interview Questions - Technical interview preparation
- 📊 Generate Diagram - Mermaid diagram creation
- 🏗️ Analyze Codebase - Deep architectural analysis
Access additional features via Ctrl+Shift+P:
- CodeBuddy: Generate Documentation - Create comprehensive docs
- CodeBuddy: Toggle Context Completion - Enable/disable smart completion
- CodeBuddy: Test Completion - Verify completion provider status
- CodeBuddy: Configure Context Completion - Adjust completion settings
- CodeBuddy: Analyze Codebase Patterns - View pattern analysis
Click the CodeBuddy icon in the Activity Bar to open the interactive chat:
- Ask questions about your code
- Upload files for analysis
- Get architectural recommendations
- Discuss implementation strategies
Access CodeBuddy settings in VS Code preferences:
{
"generativeAi.option": "Gemini", // or "Groq", "Anthropic", "XGrok", "Deepseek"
}{
"google.gemini.apiKeys": "your-gemini-api-key",
"google.gemini.model": "gemini-1.5-flash",
"anthropic.apiKey": "your-anthropic-api-key",
"groq.llama3.apiKey": "your-groq-api-key",
"deepseek.apiKey": "your-deepseek-api-key"
}{
"font.family": "JetBrains Mono",
"chatview.theme": "Atom One Dark",
"chatview.font.size": 16
}flowchart TD
%% VS Code Extension Frontend
subgraph "VS Code Extension Frontend"
CE["Editor Interface"]:::frontend
CL["Commands Layer"]:::frontend
WV1["Webview (VS Code)"]:::frontend
WV2["Webview (React UI)"]:::frontend
end
%% Core Application Layer
subgraph "Core Application"
AA["AI Agents"]:::core
MS["Memory System"]:::core
subgraph "Application Services"
BL["Business Logic"]:::core
AI["Application Interfaces"]:::core
end
subgraph "Infrastructure Layer"
HTTP["HTTP Services"]:::infra
LOG["Logging"]:::infra
REP["Repository"]:::infra
LS["Local Storage"]:::infra
end
end
%% AI Providers
subgraph "AI Providers"
LLM["Language Model Integrations"]:::provider
ESP["External Service Providers"]:::provider
end
%% Storage Layer
subgraph "Storage Layer"
DB["Database (SQLite)"]:::storage
FS["File System"]:::storage
VD["Vector Database"]:::storage
end
%% Connections
CE -->|"User Input"| CL
CL -->|"Process Request"| AA
CL -->|"UI Update"| WV1
AA -->|"Context Management"| MS
AA -->|"Orchestration"| BL
AA -->|"Contract Call"| AI
AA -->|"API Request"| HTTP
HTTP -->|"API Call"| LLM
HTTP -->|"API Call"| ESP
HTTP -->|"Feedback"| WV1
BL -->|"Data Access"| DB
BL -->|"File Access"| FS
BL -->|"Embed Data"| VD
AI -->|"Repository Access"| REP
MS -->|"Store Context"| DB
%% Styling
classDef frontend fill:#e1f5fe,stroke:#0277bd,stroke-width:2px;
classDef core fill:#e8f5e8,stroke:#2e7d32,stroke-width:2px;
classDef infra fill:#fff3e0,stroke:#ef6c00,stroke-width:2px;
classDef provider fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px;
classDef storage fill:#fce4ec,stroke:#c2185b,stroke-width:2px;
- Codebase Understanding - Comprehensive RAG-powered analysis
- Code Search - Semantic search across entire codebase
- React Webview UI - Modern, responsive interface
- AI Agent Orchestration - Multi-agent workflow coordination
- Context Pinning - Persistent context for AI models
- Documentation Generation - Automated comprehensive docs
- Real-time Data Access - External API integration
- Multiple AI Models - Support for 5 different providers
- Context-Aware Completion - Copilot-style inline suggestions
- Local LLM Support - Ollama integration for offline usage
- Multi-language Support - Python, Java, Go, and more
- Advanced Caching - Redis support for better performance
- Team Collaboration - Share contexts and documentation
- Custom Templates - Personalized documentation templates
- Integration Testing - Validate docs against actual code
codebuddy/
├── src/ # Source code
│ ├── agents/ # AI agent orchestration
│ ├── commands/ # VS Code command implementations
│ ├── llms/ # AI provider integrations
│ ├── services/ # Core business logic
│ │ ├── documentation-generator.service.ts
│ │ ├── inline-completion.service.ts
│ │ ├── context-aware-completion.service.ts
│ │ └── codebase-understanding.service.ts
│ ├── webview/ # VS Code webview components
│ ├── infrastructure/ # Infrastructure layer
│ └── extension.ts # Main extension entry point
├── webviewUi/ # React-based chat interface
├── docs/ # Documentation
└── package.json # Extension configuration
We welcome contributions! Here's how to get started:
- Fork the repository
- Create a feature branch from
development - Install dependencies:
npm install - Start development: Run → Start Debugging (F5)
- Make your changes in the new VS Code instance
- Test thoroughly with various scenarios
- Submit a pull request
- Main entry point:
src/extension.ts - React UI entry:
webviewUi/src/App.tsx - Testing: New VS Code instance opens automatically
- Build:
npm run compileandnpm run build:webview
For detailed contribution guidelines, see CONTRIBUTING.md
❓ Completion not working
- Ensure you're in a TypeScript/JavaScript file
- Check if the completion provider is active in Command Palette
- Try the "CodeBuddy: Test Completion" command
❓ API Key Issues
- Verify your API key is correctly entered in VS Code settings
- Check that you've selected the matching AI model
- Ensure your API key has sufficient credits/quota
❓ Documentation generation fails
- Make sure you have proper file permissions in the workspace
- Check that your project structure is supported
- Review the output panel for detailed error messages
❓ Performance Issues
- Try switching to a faster AI model (Groq is typically fastest)
- Clear the extension cache: Use "CodeBuddy: Restart" command
- Check your internet connection stability
- 📖 Check our documentation
- 🐛 Report issues on GitHub
- 💬 Join our community discussions
- 📧 Contact: [email protected]
- Bundle Size: ~8.7MB (Extension) + ~398KB (UI)
- Supported Languages: TypeScript, JavaScript, React, Vue
- VS Code Version: 1.78.0+
- AI Models: 5 providers supported
- Database: SQLite for local storage, Vector embeddings for search
MIT License - see LICENSE file for details.
If CodeBuddy enhances your development workflow:
- ⭐ Star the repository
- 📝 Leave a review on the VS Code Marketplace
- 🐛 Report bugs or suggest features
- 🤝 Contribute to the codebase
- 💬 Share with fellow developers
Made with ❤️ by Olasunkanmi Raymond
Transform your coding experience with AI-powered assistance. Install CodeBuddy today and code smarter, not harder!
