Skip to content

favmaclegend-ops/code_pilot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

2 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

CODEPILOT AI πŸš€

Your AI-Powered Code Assistant - Making code review and understanding effortless across your entire development workflow!

CODEPILOT AI is an intelligent suite of tools that acts as your personal coding assistant, helping you understand complex codebases, make safer changes, and collaborate more effectively with your team.

🎯 What Does CODEPILOT AI Do?

Imagine having a knowledgeable colleague who can instantly:

  • Read any code file and explain what it does in plain English
  • Understand the "why" behind code decisions and design choices
  • Predict impact of changes before you make them
  • Track context across your entire codebase
  • Analyze dependencies and relationships between files
  • Help onboard new team members faster

πŸ—οΈ Project Structure

codepilot-ai/
β”œβ”€β”€ vscode-extension/          # VS Code Extension (Ready for Use!)
β”‚   β”œβ”€β”€ extension.ts          # Main extension logic
β”‚   β”œβ”€β”€ package.json         # Extension manifest
β”‚   β”œβ”€β”€ README.md            # Extension documentation
β”‚   β”œβ”€β”€ CONTRIBUTING.md      # How to contribute
β”‚   └── test/                # Test suite
β”œβ”€β”€ backend/                  # Backend Services
β”‚   β”œβ”€β”€ intent-extractor/    # Code intent analysis
β”‚   β”œβ”€β”€ impact-analyzer/     # Change impact prediction
β”‚   β”œβ”€β”€ context-tracker/     # Context tracking system
β”‚   β”œβ”€β”€ git-analyzer/        # Git integration utilities
β”‚   └── db/                  # Database layer
β”œβ”€β”€ ai-engine/               # AI Core Components
β”‚   β”œβ”€β”€ summarizer.ts        # Code summarization
β”‚   β”œβ”€β”€ impact-predictor.ts  # Impact prediction AI
β”‚   └── llmHook.ts          # Language model integration
└── shared/                  # Shared utilities
    └── utils/               # Common utilities

πŸš€ Quick Start

Using the VS Code Extension

  1. Navigate to the extension directory:

    cd vscode-extension
  2. Install dependencies:

    npm install
  3. Build the extension:

    npm run build
  4. Run tests:

    npm test
  5. Install the extension:

    npm run package
    code --install-extension codepilot-ai-extension-0.1.0.vsix

Available Commands in VS Code

  • CODEPILOT: Show File Summary - Get AI-powered summaries of your code
  • CODEPILOT: Show Why Summary - Understand the purpose behind your code
  • CODEPILOT: Show Impact Report - Analyze potential change impacts

πŸ”§ Development Setup

Prerequisites

  • Node.js (v16 or higher)
  • VS Code (latest version)
  • Git

Full Development Environment

# Clone the repository
git clone https://github.com/favmaclegend-ops/code_pilot.git
cd code_pilot

# Install VS Code extension dependencies
cd vscode-extension
npm install
npm run build
npm test

# Set up backend services (coming soon)
cd ../backend
# Additional setup instructions coming soon

πŸ“¦ Components

πŸ”Œ VS Code Extension (Current Focus)

  • Status: βœ… Ready for use
  • Features: File summaries, intent analysis, impact reports
  • Architecture: Local-first with graceful fallbacks
  • Testing: Comprehensive test suite

🧠 AI Engine (In Development)

  • Status: 🚧 Under development
  • Purpose: Core AI models for code understanding
  • Features: Summarization, impact prediction, context tracking

βš™οΈ Backend Services (Planned)

  • Status: πŸ“‹ Planned
  • Purpose: Scalable backend for team features
  • Features: Multi-user support, shared knowledge base

🎯 Current Status

βœ… Completed

  • VS Code extension with three core commands
  • Comprehensive test suite (100% passing)
  • Documentation and contribution guidelines
  • Extension packaging and distribution ready
  • Mock implementations for development

🚧 In Progress

  • AI model integration
  • Backend service architecture
  • Performance optimization

πŸ“‹ Planned

  • Multi-language support
  • Team collaboration features
  • Git integration
  • Custom AI model training
  • Web interface

🀝 Contributing

We welcome contributions from developers of all skill levels! Here's how you can help:

Priority Areas

  1. AI Model Integration - Replace mocks with real AI models
  2. Backend Development - Build scalable backend services
  3. Testing - Expand test coverage
  4. Documentation - Improve guides and examples

How to Contribute

  1. Check out our Contributing Guide
  2. Look at open issues
  3. Fork the repository and create a pull request

πŸ“š Documentation

🌟 Features Roadmap

Next Release (v0.2.0)

  • Real AI model integration
  • Improved error handling
  • Performance optimizations
  • Multi-language support

Future Releases

  • Team collaboration features
  • Git integration
  • Custom AI model training
  • Web interface
  • Mobile app

πŸ“„ License

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

πŸ”— Links

πŸ’‘ Why CODEPILOT AI?

In today's fast-paced development environment, understanding code quickly is crucial. CODEPILOT AI bridges the gap between complex codebases and developer understanding, making code review, onboarding, and collaboration more efficient than ever.

Key Benefits

  • Faster Code Understanding - Get up to speed on any codebase quickly
  • Safer Changes - Understand impact before making modifications
  • Better Collaboration - Share knowledge across your team
  • Improved Onboarding - Help new developers learn faster
  • Privacy-First - All processing happens locally

Ready to transform your coding experience? Start with the VS Code extension and join our growing community of developers making code more accessible! πŸš€

Made with ❀️ by the CODEPILOT AI community

About

πŸš€ **Your AI-Powered Code Assistant** - Making code review and understanding effortless!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published