索引你的工作区

当你的工作区被索引后,Augment 就能基于你独特的 codebase、最佳实践、编码模式和偏好,提供定制化的代码建议和解答。你始终可以控制哪些文件被索引。

关于工作区索引

当你在启用了 Augment 的情况下打开一个工作区,你的 codebase 会自动上传到 Augment 的安全云端。你可以通过 .gitignore.augmentignore 文件控制哪些文件被索引。索引过程通常少于一分钟,但具体时间取决于你的 codebase 大小。在 Visual Studio Code 中,你可以使用 Workspace Context 来 查看哪些文件被索引,也可以 添加额外上下文

安全性与隐私

Augment 会安全且私密地存储你的代码,以支持强大的上下文引擎。我们通过 proof-of-possession API 确保代码的隐私,并严格遵守数据最小化原则。点击查看我们的安全策略

索引哪些内容

Augment 会索引你工作区中的所有文件,除非这些文件在 .gitignore.augmentignore 中被排除。你可以通过 Workspace Context 查看被索引的文件

使用 .augmentignore 忽略文件

.augmentignore 是一个文件模式列表,用于告诉 Augment 在索引时忽略哪些文件。在你的工作区根目录创建一个 .augmentignore 文件。这个文件支持所有 gitignore 兼容的 glob 模式。

包含被 .gitignore 忽略的文件

如果你有一些在 .gitignore 中被排除的文件,希望它们仍然被索引,可以在 .augmentignore 中使用 ! 前缀手动包含它们。

比如,你可能希望让 node_modules 被索引,以便 Augment 能了解你的项目依赖信息,但它通常会被 .gitignore 排除。这时你可以在 .augmentignore 中添加 !node_modules

.augmentignore 示例:

  1. # 使用 ! 前缀包含被 .gitignore 忽略的文件
  2. !node_modules
  3. # 使用 .gitignore 语法排除其他文件
  4. data/test.json