Local Code Search

🚀 用於Cursor的本地代碼索引

本項目是一個實驗性的Python服務器，它能在本地藉助ChromaDB對代碼庫進行索引，還能通過MCP（模型上下文協議）服務器為工具（如Cursor）提供語義搜索功能，幫助用戶更高效地查找代碼。

🚀 快速開始

以下是使用本項目的詳細步驟：

1. 克隆倉庫並進入目錄：

   git clone <repository-url>
   cd cursor-local-indexing
   

2. 創建.env文件，通過複製.env.example實現：

   cp .env.example .env
   

3. 配置您的.env文件：

   PROJECTS_ROOT=~/your/projects/root    # 您的項目目錄路徑
   FOLDERS_TO_INDEX=project1,project2    # 以逗號分隔要索引的文件夾列表
   

   示例：

   PROJECTS_ROOT=~/projects
   FOLDERS_TO_INDEX=project1,project2
   

4. 啟動索引服務器：

   docker-compose up -d
   

5. 配置Cursor以使用本地搜索服務器： 創建或編輯~/.cursor/mcp.json文件：

   {
     "mcpServers": {
       "workspace-code-search": {
         "url": "http://localhost:8978/sse"
       }
     }
   }
   

6. 重啟Cursor IDE以應用更改。 服務器將開始索引您的指定項目，您將在這些項目處於活動狀態時在Cursor中使用語義代碼搜索。
7. 打開配置為已索引的項目。 創建一個.cursorrules文件並添加以下內容：

   <指令>
   對於任何請求，首先使用@search_code工具檢查代碼的功能。
   儘可能優先使用該工具，而不是命令行中的grep等操作。
   </指令>
   

8. 啟用Cursor Agent模式，見證本地向量搜索的力量！

📦 安裝指南

克隆倉庫

git clone <repository-url>
cd cursor-local-indexing

配置環境文件

cp .env.example .env

編輯.env文件：

PROJECTS_ROOT=~/your/projects/root    # 您的項目目錄路徑
FOLDERS_TO_INDEX=project1,project2    # 以逗號分隔要索引的文件夾列表

啟動服務器

docker-compose up -d

配置Cursor

創建或編輯~/.cursor/mcp.json文件：

{
  "mcpServers": {
    "workspace-code-search": {
      "url": "http://localhost:8978/sse"
    }
  }
}

重啟Cursor IDE

重啟後服務器會開始索引指定項目。

打開項目並配置規則

創建.cursorrules文件：

<指令>
對於任何請求，首先使用@search_code工具檢查代碼的功能。
儘可能優先使用該工具，而不是命令行中的grep等操作。
</指令>

啟用Agent模式

啟用Cursor Agent模式，體驗本地向量搜索。