Index your workspace

​

About indexing your workspace

When you open a workspace with Augment enabled, your codebase will be automatically uploaded to Augment’s secure cloud. You can control what files get indexed using .gitignore and .augmentignore files. Indexing usually takes less than a minute but can take longer depending on the size of your codebase. In Visual Studio Code, you can use Workspace Context to view what files are indexed and add additional context.

​

Security and privacy

Augment stores your code securely and privately to enable our powerful context engine. We ensure code privacy through a proof-of-possession API and maintain strict internal data minimization principles. Read more about our security.

​

What gets indexed

Augment will index all the files in your workspace, except for the files that match patterns in your .gitignore file and the .augmentignore file. You can view what files are indexed in Workspace Context.

​

Ignoring files with .augmentignore

The .augmentignore file is a list of file patterns that Augment will ignore when indexing your workspace. Create an .augmentignore file in the root of your workspace. You can use any glob pattern that is supported by the gitignore file.

​

Including files that are .gitignored

If you have a file or directory in your .gitignore that you want to indexed, you can add it to your .augmentignore file using the ! prefix.

For example, you may want your node_modules indexed to provide Augment with context about the dependencies in their project, but it is typically included in their .gitignore. Add !node_modules to your .augmentignore file.

# Include .gitignore excluded files with ! prefix
!node_modules

# Exclude other files with .gitignore syntax
data/test.json