🚀 3-Step Quick Setup for VoidMuse

October 30, 2025 · View on GitHub

💡 Transform your IDE into an AI assistant in just 3 minutes!

Hey! Want to quickly experience VoidMuse's powerful features? Follow this super simple configuration guide, get it done in three steps, and start your AI programming journey right away!

📋 Configuration Checklist

Before we start, we need to configure these three core functions:

  • ✅ Step 1: Configure AI Model (Required) - Enable AI to understand and answer your questions
  • ✅ Step 2: Configure Search Function (Recommended) - Enable AI to search for the latest information
  • ✅ Step 3: Configure Code Understanding (Recommended) - Enable AI to deeply understand your codebase

🎯 Tip: Step 1 is mandatory, the following two steps can be configured as needed!

🎯 Step 1: Configure AI Model - Make AI Talk

Why Choose Alibaba Cloud Bailian?

🎁 Free Benefits: Each model comes with 1 million tokens of free quota, enough for long-term use!
🚀 Rich Models: Supports the latest DeepSeek-R1, DeepSeek-V3, and other popular models
⚡ Fast Speed: Excellent domestic access speed, say goodbye to network lag

🌐 Alternative Choice: OpenRouter

If you want to experience more AI models (like GPT-4, Claude, Gemini, etc.), you can choose OpenRouter:

🌟 Rich Models: Integrates almost all mainstream AI models on the market
💳 Convenient Payment: Supports domestic payment methods like WeChat Pay and Alipay
🔧 Unified Interface: Access all models with one API Key

📖 Detailed Configuration: Check OpenRouter Detailed Configuration Guide for complete recharge and configuration process

Quick API Key Acquisition

Step 1: Register Alibaba Cloud Account

Step 2: Get API Key

API Key Acquisition Diagram 1 API Key Acquisition Diagram 2

Step 3: Configure in VoidMuse

  • Open VoidMuse settings interface
  • Find "AI Model Configuration" section
  • Paste your API Key
  • Select your preferred model (recommend DeepSeek-V3)

Model Configuration

🔍 Step 2: Configure Search Function - Give AI Internet Access

Why Need Search Function?

🌐 Real-time Information: Get the latest technology trends and solutions
📚 Knowledge Expansion: Access information beyond the AI model's training data
🎯 Precise Answers: Combine search results for more accurate responses

Advantages:

  • 🌍 Global coverage, rich information
  • 🎯 High search accuracy
  • 🔧 Easy configuration

Configuration Steps:

  1. Get Google Search API Key
  2. Configure Custom Search Engine
  3. Add configuration to VoidMuse

📖 Detailed Tutorial: Google Search Configuration Guide

Option 2: Bocha Search (Domestic Alternative)

Advantages:

  • 🇨🇳 Optimized for Chinese content
  • 🚀 Fast domestic access
  • 💰 Cost-effective

📖 Detailed Tutorial: Bocha Search Configuration Guide

🧠 Step 3: Configure Code Understanding - Make AI Your Code Expert

What is Code Understanding?

🔍 Code Analysis: AI can read and understand your entire codebase
💡 Intelligent Suggestions: Provide context-aware code suggestions
🐛 Bug Detection: Help identify potential issues in code

Configuration Methods

  • Uses the same AI model API configured in Step 1
  • Automatically processes and indexes your code
  • No additional configuration needed

Auto Embedding

Method 2: Local Embedding

  • Runs embedding models locally
  • Better privacy protection
  • Requires more computational resources

Local Embedding

Quick Setup

  1. Open VoidMuse settings
  2. Navigate to "Code Understanding" section
  3. Choose "Automatic Embedding"
  4. Click "Start Indexing"
  5. Wait for indexing to complete

🎉 Congratulations! Setup Complete

Now you can:

  • 💬 Chat with AI: Ask any programming questions
  • 🔍 Search Information: Get real-time search results
  • 🧠 Understand Code: Let AI analyze your codebase

Next Steps

🆘 Need Help?

Happy coding with VoidMuse! 🚀