About syncing your workspace

When you open a workspace with Augment enabled, your codebase will be automatically synced to Augment secure cloud. You can control what files get synced using .gitignore and .augmentignore files. Syncing 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 synced and add additional context.

What gets synced

Augment will sync 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 synced in Workspace Context.

Ignoring files with .augmentignore

The .augmentignore file is a list of file patterns that Augment will ignore when syncing 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 sync, you can add it to your .augmentignore file using the ! prefix.

For example, many people want their node_modules synced 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.