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模式，体验本地向量搜索。