索引你的工作区(workspace)

一旦你的工作区被索引,Augment 就能基于你独有的代码库、最佳实践、编码习惯和风格,提供更贴合的代码建议和答案。而且你随时可以控制哪些文件会被索引。

关于索引工作区

当你打开启用了 Augment 的工作区时,Augment 会自动将你的代码库上传到它们的安全云端进行索引。你可以通过 .gitignore.augmentignore 文件控制哪些文件被索引。索引过程一般在一分钟以内完成,但如果代码库比较大,也可能需要更长时间。

安全与隐私

Augment 会安全私密地存储你的代码,以支持它强大的上下文引擎。他们使用 proof-of-possession API 来保证代码访问安全,并且内部也坚持数据最小化原则。你可以查看 官方的安全说明 获取更多细节。

哪些文件会被索引

默认情况下,Augment 会索引工作区下的所有文件,除了 .gitignore.augmentignore 文件中匹配到的路径。

使用 .augmentignore 忽略文件

.augmentignore 文件是专门用来告诉 Augment 哪些文件不要被索引的。你可以在项目根目录创建一个 .augmentignore 文件,并用类似 .gitignore 的 glob 模式来写匹配规则。

想让 .gitignore 中的文件被索引?

如果你希望某些 .gitignore 中忽略掉的文件仍然被索引,可以在 .augmentignore 中用 ! 前缀把它们加回来。

比如说:你可能希望 Augment 能识别 node_modules 中的依赖内容(虽然通常这个目录会被 .gitignore 排除掉)。那你可以这样写:

.augmentignore

  1. # 用 ! 把 .gitignore 忽略的文件包含进来
  2. !node_modules
  3. # 忽略其他文件,语法跟 .gitignore 一样
  4. data/test.json