Repository files navigation

AI-powered codebase search and Q&A for VS Code, powered byMemvid.

Index your workspace once, then ask questions about your code in natural language.

• One-Click Indexing - Index your entire workspace with a single button click
• Incremental Indexing - Only re-index changed files for faster updates
• Natural Language Q&A - Ask questions about your codebase in plain English
• Semantic Search - Find code by meaning, not just keywords
• Sidebar Chat - Interactive chat panel for ongoing conversations
• Context Menu Actions - Right-click on code to ask questions, explain, or find similar code
• Cloud Sync - Sync your index to Memvid cloud for backup and sharing
• Keyboard Shortcuts - Quick access withCmd+Shift+M (macOS) orCtrl+Shift+M

1. Install the extension
2. Open a workspace/folder
3. Click "Index Workspace" in the Memvid sidebar
4. Start asking questions!

• Node.js 18+
• OpenAI API Key (required for Q&A, optional for local embeddings)

Add to your VS Code settings (Cmd+,):

{"memvid.openaiApiKey":"sk-..."}

Or set the environment variable:

export OPENAI_API_KEY="sk-..."

• "How does authentication work in this project?"
• "Where is the database connection configured?"
• "What API endpoints are available?"
• "Explain the user registration flow"
• "Find all error handling code"

1. Indexing: Memvid reads your source files, generates embeddings, and stores them in a portable.mv2 file
   • Supports incremental indexing to only process changed files
   • Parallel file reading for faster indexing
   • Configurable batch sizes for optimal performance
2. Search: Uses hybrid BM25 + vector search to find relevant code
3. Q&A: Retrieves relevant code snippets and uses an LLM to synthesize answers
4. Cloud Sync: Syncs your index to Memvid cloud using tickets for version control

Sync your indexed codebase to Memvid cloud for backup, sharing, and access from other devices.

1. Get your API key frommemvid.com/dashboard
2. Create a Memory in the dashboard to get a Memory ID
3. RunMemvid: Configure Cloud Sync and enter your credentials
4. RunMemvid: Sync to Cloud to sync your index

{"memvid.apiKey":"mv2_your_api_key_here","memvid.memoryId":"mem_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","memvid.autoSync":true}

• Your code stays local - only indexed in a local.mv2 file
• Search queries are processed locally using embeddings
• Only Q&A requests are sent to OpenAI (with relevant code context)
• No telemetry or analytics by default

# Install dependenciesnpm install# Compile TypeScriptnpm run compile# Watch modenpm run watch# Package extensionnpm run package

1. Build and Run:

   npm run compile# Press F5 in VS Code to launch extension in development mode

2. Test Features:

   • Set API key viaMemvid: Set OpenAI API Key
   • Index workspace viaMemvid: Index Workspace
   • Ask questions via chat panel orMemvid: Ask Question
   • Test context menu actions (right-click on selected code):
     • Ask about this code
     • Explain this code
     • Find similar code
     • Add to context
   • Test cloud sync functionality
   • View index statistics

RunMemvid: Index Workspace command first.

Setmemvid.openaiApiKey in settings orOPENAI_API_KEY env var.

• Increasememvid.maxFileSize threshold
• Add more patterns tomemvid.excludePatterns
• Consider indexing specific folders only

Licensed under the Apache License, Version 2.0. SeeLICENSE for details.

• Memvid Documentation
• GitHub
• Discord