Agent 和 Chat 的使用指南

你可以用自然语言写一些自定义的指南，来让 Agent 和 Chat 更符合你的偏好、最佳实践、风格以及技术栈。

关于指南

Agent 和 Chat 的指南是一种自然语言指令，能帮助 Augment 给出更准确、更相关的回复。指南特别适合用来告诉 Augment 一些不能靠 linter 或编译器管理的偏好，比如特定的依赖版本、风格或者实现细节。你可以为某个特定 workspace 添加指南，也可以全局设置让所有 Chat 都遵循；不过指南目前不适用于 Completions、Instructions 或 Next Edit。

用户指南

添加用户指南

你可以通过点击 Context 菜单，或者在 Chat 输入框里打 @ 来添加用户指南。用户指南会被应用到所有打开编辑器里的所有 Chat 对话中。

1. 选择 User Guidelines
2. 输入你的指南（下面有一些写法建议）
3. 点击 Save

更新或删除用户指南

你可以通过点击 User Guidelines 的 context chip 来更新或删除你的指南。修改内容后点击 Save 就可以了。你在任何编辑器里修改的指南，都会同步到所有打开的编辑器中。

Workspace 指南

你可以在代码库根目录添加一个 .augment-guidelines 文件，来为这个代码库中的所有 Agent 和 Chat 会话设置一套统一的指南。这个 .augment-guidelines 文件应该加入版本控制系统，这样团队里所有人都能遵守同样的指南。

写好指南的小贴士

• 把指南写成一个列表
• 使用简单、清晰、简洁的语言
• 要求“回答越短越好”或者“只要代码”可能会影响回答质量

用户指南示例

• 需要额外解释（例如：对于 Typescript 代码，多解释一下这段代码的作用）
• 设置首选语言（例如：用西班牙语回答问题）

Workspace 指南示例

• 指定首选库（例如：pytest 比 unittest 更优先）
• 明确推荐模式（例如：在 NextJS 中使用 App Router 和 server components）
• 禁用某些反模式（例如：不允许使用已废弃的内部模块）
• 定义命名规范（例如：函数名必须以动词开头）

限制

指南目前最长不能超过 2000 个字符。