如何使用 .cursorignore 文件从 Cursor 的代码库索引中排除特定文件和目录

2025-01-08 15:35 更新

.cursorignore​ 文件允许您从 Cursor 的代码库索引中排除文件和目录

关于 .cursorignore

要忽略文件以避免被包含在 代码库索引 中,您可以在项目的根目录中使用 .cursorignore 文件。它的工作方式与 ​.gitignore​ 对 git 的工作方式相同。

.cursorignore​ 尊重 ​.gitignore​。如果您已经有 ​.gitignore​,则默认情况下将忽略这些文件。如果您想忽略其他文件,可以将它们添加到 ​.cursorignore​ 文件中。

您可以在我们的 安全页面 上阅读更多关于此如何工作的内容。


聊天和 Composer 上下文

目前,Cursor 聊天和 Composer 可以访问其上下文中的所有文件,无论 ​.cursorignore​ 设置如何。

有关我们如何处理 AI 请求的更多信息,请访问我们的 安全页面。

示例 ​.cursorignore​ 文件

忽略特定文件

# 忽略 `dist` 目录中的所有文件
dist/

# 忽略所有 `.log` 文件
*.log

# 忽略特定文件 `config.json`
config.json

仅包含特定文件

仅包含 app 目录中的 ​*.py​ 文件。请注意,这与 ​.gitignore​ 的语法相同。

# 忽略所有内容
*
# 不忽略 app
!app/
# 不忽略 app 内的目录
!app/*/
!app/**/*/
# 不忽略 Python 文件
!*.py


故障排除

忽略文件的语法有时会有些混淆。​.cursorignore​ 文件遵循与 ​.gitignore​ 完全相同的语法,因此如果您尝试使用忽略文件但它没有按预期工作,我们建议您在 Google 上搜索该问题,将搜索查询中的 cursorignore 替换为 gitignore。可能会有人遇到过相同的问题,StackOverflow 上会有好的答案。

一个常见的例子:这是如何忽略所有文件,除了那些具有 .php 扩展名的文件(仅添加 ​*​ 后跟​ !*.php​ 不起作用,因为 ​gitignore​ 文件发现器不会深入并发现子目录中的任何 ​.php​ 文件)。


以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号