跳到主要内容

.cursorignore 忽略文件

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

关于 .cursorignore

要在代码库索引中忽略某些文件,你可以 在项目根目录中使用 .cursorignore 文件。它的工作方式与 git 的 .gitignore 相同。

.cursorignore 会遵循 .gitignore 的设置。如果你已经有 .gitignore,这些文件默认会被忽略。 如果你想要忽略额外的文件,可以将它们添加到 .cursorignore 文件中。

你可以在我们的安全页面了解更多关于这个功能的工作原理。

Chat 和 Composer 上下文

目前,Cursor Chat 和 Composer 可以访问其上下文中的所有文件,不受 .cursorignore 设置的影响。

更多关于我们如何处理 AI 请求的信息可以在我们的安全页面找到。

.cursorignore 文件示例

Ignore specific files 忽略特定文件

# Ignore all files in the `dist` directory
dist/

# Ignore all `.log` files
*.log

# Ignore specific file `config.json`
config.json

仅包含特定文件

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

# ignore everything
*
# do not ignore app
!app/
# do not ignore directories inside app
!app/*/
!app/**/*/
# don't ignore python files
!*.py

故障排除

忽略文件语法有时会有点令人困惑。.cursorignore 文件使用与 .gitignore 完全相同的语法,所以如果你尝试使用忽略文件但它没有按预期工作,我们建议你在 Google 中搜索这个问题,将搜索查询中的 cursorignore 替换为 gitignore。可能有人遇到过相同的问题,而 StackOverflow 会有一个好的答案。

一个常见的例子:这里介绍了如何忽略除了 .php 扩展名以外的所有文件(仅添加 * 后跟 !*.php 是不行的,因为 gitignore 文件发现器不会深入到子目录中去发现 .php 文件)。