You can provide custom rules and guidelines written in natural language to improve Agent and Chat with your preferences, best practices, styles, and technology stack.
User Guidelines
.augment/rules
directory. Currently, we support 3 types of rules:
*.md
or *.mdx
. You can also manually import rules inside of Settings > Import rules.
.augment-guidelines
(legacy).augment-guidelines
file to the root of a repository to specify a set of guidelines that Augment will follow for all Agent and Chat sessions on the codebase. The .augment-guidelines
file should be added to your version control system so that everyone working on the codebase has the same guidelines.
User Guideline Examples
For Typescript code, explain what the code is doing in more detail
Respond to questions in Spanish
Rule Examples
Python 3.13.5
for the dependencies inside your project
Workspace Guideline Examples
pytest vs unittest
For NextJS, use the App Router and server components
a deprecated internal module
functions start with verbs
How are Rules different from Guidelines?
.augment/rules
root that will allow you to split up previous Guidelines into multiple files to more precisely define your preferences..augment-guidelines
file are a legacy set of rules that can be edited by editing the .augment-guidelines
in your repository. Augment will automatically import Workspace Guidelines as Rules which you can access under Settings > User Guidelines and Rules.What are the current limitations?