MEmoX ✨ | Your Intelligent Coding Companion

Code Smarter, Build Faster

Seamless AI assistance that works where you work - online or offline.

💡 Why MEmoX?

MEmoX empowers developers with AI-driven insights directly within VS Code. Whether you're connected to the internet or working in an isolated environment, MEmoX adapts to your needs with its innovative dual-mode operation.

✨ Key Features

🧠 Smart Coding Assistant Get instant answers about your codebase Receive contextual improvement suggestions Generate documentation with a single prompt Debug complex issues with AI guidance	🔄 Work Anywhere Offline Mode: Powered by local CodeLLaMA via Ollama Online Mode: Enhanced capabilities through cloud APIs Seamless switching based on connectivity
🔍 Deep Code Understanding Advanced semantic search with vector indexing Context-aware responses to your queries Support for multiple languages and frameworks	🛡️ Privacy-First Design Secure GitHub authentication Local processing option for sensitive code Transparent data handling policies

• 🔒 Secure Authentication
  • GitHub OAuth integration for secure sign-in
  • Personal access token support for alternative authentication
  • Securely stored credentials

🚀 Getting Started

Prerequisites

✅ VS Code 1.85.0+
✅ Node.js 16.x+
✅ For offline mode: Ollama with CodeLLaMA

Quick Installation

# Clone the repository
git clone https://github.com/MemoraNet/MEmoX.git

# Navigate to the directory
cd MEmoX

# Install dependencies
npm install

# Build the extension
npm run compile

# Start using it!
code .

Installation from VS Code Marketplace

1. Open VS Code Extensions panel (Ctrl+Shift+X or Cmd+Shift+X)
2. Search for "MEmoX"
3. Click "Install"
4. Reload VS Code when prompted

⚙️ Configuration

Customize MEmoX through VS Code settings:

Setting	Description	Options
memox.mode	Operation mode	auto, offline, online
memox.modelSize	Local model size	auto, 3B, 7B
memox.githubAuth	GitHub authentication	OAuth credentials
memox.indexDepth	Code indexing depth	standard, deep

Environment Variables

For sensitive credentials, MEmoX supports environment variables via a .env file:

# GitHub OAuth credentials
GITHUB_CLIENT_ID=your_github_client_id_here
GITHUB_CLIENT_SECRET=your_github_client_secret_here

# OpenAI API credentials for cloud capabilities
OPENAI_API_KEY=your_openai_api_key_here
OPENAI_API_URL=https://api.openai.com/v1/chat/completions

Copy .env.example to .env and add your credentials. This file is automatically ignored by Git for security.

🔐 Authentication

MEmoX provides a streamlined authentication experience:

1. Click the "Sign In" button in the MEmoX panel
2. Authorize with GitHub (or use a Personal Access Token)
3. Start using all features immediately

📘 Detailed Authentication Instructions

For enterprise setups and custom configurations, see our Authentication Guide.

🛠️ Development

Architecture Overview

MEmoX is built with modularity and performance in mind:

graph TB
    A[Extension Entry] --> B[Auth Service]
    A --> C[RAG System]
    A --> D[Chat Interface]
    C --> E[Vector Store]
    C --> F[Code Chunker]
    D --> G[UI Components]
    D --> H[History Manager]

Loading

Project Structure

src/
├── auth/           # Authentication components
├── chat/           # Chat UI and history management
├── rag/            # Retrieval-augmented generation system
└── extension.ts    # Main extension file

Development Workflow

# Watch mode for development
npm run watch

# Run linting
npm run lint

# Run tests
npm run test

👥 Contributing

We welcome contributions! Check out our contribution guidelines to get started.

📄 License

MIT License - Copyright © 2025 MemoraNet

📊 Usage Examples

Ask About Your Code

> Explain the purpose of the RAGManager class in this project

Generate Code with Context

> Create a function to parse the user input and extract keywords

Get Debugging Help

> Why is my message not showing in the chat panel?

🌟 Community & Support

• 💬 Join our Discord
• 🐛 Report Issues
• 📧 Contact Support

---

_{Built with ❤️ by the MemoraNet team}