代码库索引

代码库索引是 Cursor 的一项功能,它允许 AI 理解你的整个代码库上下文。启用后,Cursor 会分析你的项目文件,创建一个索引,使 AI 能够提供更准确的代码补全、建议和问题解答。

工作原理

  1. 索引创建:Cursor 会扫描你的项目目录,解析代码文件
  2. 向量存储:代码被转换为向量表示并存储在本地
  3. 语义搜索:当与 AI 交互时,Cursor 使用这些向量来查找相关代码片段

启用索引

要启用代码库索引:

  1. 打开 Cursor 设置 (Ctrl/Cmd + ,)
  2. 导航到 AI 部分
  3. 开启 Enable Codebase Indexing 选项
// 设置示例
{
  "ai.codebaseIndexing.enabled": true
}

配置选项

你可以通过以下设置自定义索引行为:

设置项描述默认值
ai.codebaseIndexing.includePatterns要包含的文件模式["**/*"]
ai.codebaseIndexing.excludePatterns要排除的文件模式["**/node_modules/**"]
ai.codebaseIndexing.maxFileSize索引的最大文件大小 (KB)500

最佳实践

  1. 排除大文件:避免索引大型二进制文件或日志文件
  2. 包含相关文件:确保所有需要 AI 理解的文件都被包含
  3. 定期更新:在重大代码变更后重建索引

重建索引

如果需要手动重建索引:

  1. 打开命令面板 (Ctrl/Cmd + Shift + P)
  2. 搜索并选择 Cursor: Rebuild Codebase Index

限制

  • 索引过程可能会消耗较多系统资源
  • 非常大的代码库可能需要更长时间来索引
  • 某些特殊文件类型可能不被支持

索引数据仅存储在本地,不会发送到任何远程服务器。

代码库索引

为了在使用 @codebaseCtrl/⌘ Enter 时获得更好、更准确的代码库回答,你可以为代码库建立索引。Cursor 会在后台为代码库中的每个文件计算嵌入向量,并利用这些向量来提高代码库回答的准确性。

你的代码库索引会自动与最新的代码变更保持同步。

代码库索引的状态可以在 Cursor 设置 > 功能 > 代码库索引 下查看。

高级设置

默认情况下,Cursor 会索引代码库中的所有文件。

你也可以展开 显示设置 部分来访问更多高级选项。在这里,除了 .gitignore 设置之外,你还可以决定是否要为新仓库启用自动索引,并配置 Cursor 在仓库索引过程中要忽略的文件。

如果你的项目中有任何 AI 绝对不需要读取的大型内容文件,忽略这些文件 可能会提高回答的准确性。