AGENTS.md文件:由你或团队维护的持久指令,适合放开发规范、项目结构、常用命令和协作约定。- 自动记忆:启用后由 Qoder CLI 在本机保存的 Markdown 记忆,适合记录后续会话仍有用的偏好、反馈、项目背景和外部参考。
记忆类型
| 机制 | 谁来写 | 适合内容 | 作用域 | 查看入口 |
|---|---|---|---|---|
AGENTS.md | 用户或团队 | 明确、稳定、希望每次会话都遵守的说明 | 用户级、项目级、本地项目级、插件提供 | /memory |
| 自动记忆 | Qoder CLI | 从对话中学到的可复用信息,例如偏好、反馈、项目背景、外部资料位置 | 项目级;可选用户级 | /memory 打开 auto-memory folder;/memory manage 管理主题文件 |
AGENTS.md
AGENTS.md 是 Qoder CLI 默认的上下文文件名。启动或刷新记忆时,Qoder CLI 会读取可用的 AGENTS.md 文件,并把内容作为上下文注入会话。
常用位置
| 位置 | 用途 | 是否适合提交 |
|---|---|---|
~/.qoder/AGENTS.md | 当前用户跨项目通用偏好和工作习惯 | 否 |
<project>/AGENTS.md | 团队共享的项目规则、架构说明、常用命令 | 是 |
<project>/AGENTS.local.md | 当前机器上的项目私有说明,例如本地服务地址或个人测试数据 | 否 |
context.fileName 设置单个文件名或文件名数组。默认值是 AGENTS.md。
加载逻辑
启动或刷新记忆时,Qoder CLI 的项目记忆只做“向上查找”,不会扫描子目录:- 用户级记忆:加载用户配置目录中的
AGENTS.md。 - 项目和本地项目记忆:在可信工作区内,从当前工作区目录向父目录查找
AGENTS.md和AGENTS.local.md,默认到.git所在目录为止。 - 子目录记忆:启动时不预加载。只有 Qoder CLI 成功读取子目录里的文件后,才会从该文件所在目录向上补充此前未加载的
AGENTS.md和AGENTS.local.md。这些按需加载的内容会进入后续上下文,并显示在/memory中。
/repo/packages/app 启动时,会检查:
/repo 启动,则不会预加载 /repo/packages/app/AGENTS.md;需要访问 packages/app 下的文件后才会按需加载。
编写建议
把AGENTS.md 当成“下次会话还要知道的事实和约定”。适合写:
- 构建、测试、格式化和发布命令
- 项目目录结构和关键模块边界
- 代码风格、命名规则和评审要求
- 团队约定的工作流,例如提交、分支、测试数据准备
- 对当前仓库长期有效的安全或合规注意事项
- 只对当前这次任务有用的临时状态
- 会很快过期的排期和进度
- 已经能从代码或 README 直接看出的长篇重复内容
- 必须强制执行的安全策略。此类要求应放进权限配置或 Hooks
导入其他文件
AGENTS.md 可以用 @path/to/file 引入其他文件。相对路径基于当前 AGENTS.md 所在目录解析。
- 支持相对路径、绝对路径和
~/路径。 - Markdown 行内代码和代码块中的
@...不会被当作导入。 - 项目和本地项目记忆默认只允许导入项目边界内的文件;指向项目外的导入需要显式批准或通过安全设置允许。
- 导入会递归展开,并有深度限制,避免循环导入无限展开。
@README.md,请写成 `@README.md`。
自动记忆
自动记忆启用后,Qoder CLI 会在对话过程中把值得跨会话复用的信息保存为本机 Markdown 文件。它不会把每段对话都保存下来,而是根据内容判断是否值得记住。适合保存的内容
自动记忆支持四类内容:| 类型 | 用途 |
|---|---|
user | 用户角色、长期偏好、跨项目工作习惯 |
feedback | 用户对工作方式的纠正或确认,例如“以后不要这样做” |
project | 当前项目中无法直接从代码推导出的背景、约束或决策原因 |
reference | 外部系统、看板、仪表盘、文档等资料位置 |
启用自动记忆
自动记忆只在交互式会话中运行。当前实现使用环境变量作为有效开关:QODER_MEMORY_USER 只有在 QODER_MEMORY 已启用时才生效。未启用自动记忆时,/memory 仍可管理 AGENTS.md 文件;/memory manage 会提示自动记忆不可用。
自动记忆存储位置
项目级自动记忆保存在当前项目对应的 Qoder 配置目录下:MEMORY.md 索引和若干主题文件:
MEMORY.md 是索引,不应写入长篇正文。Qoder CLI 启动时会读取每个活跃自动记忆根的 MEMORY.md,最多读取前 200 行或约 25KB。更详细的内容应放在单独的主题文件中,由索引指向。
查看和管理
在 TUI 中输入:/memory 会打开记忆概览,显示用户级、项目级、本地项目级记忆文件,并在自动记忆启用时显示 Open auto-memory folder 入口。选择该入口会用系统文件管理器打开对应的 auto-memory folder。
如果要在 TUI 内按主题文件管理自动记忆:
/memory manage 会打开自动记忆管理器,可以查看、打开、编辑或删除自动记忆主题文件。删除主题文件时,Qoder CLI 会同步移除对应 MEMORY.md 索引行。
让 Qoder CLI 记住或忘记
可以直接用自然语言表达:AGENTS.md:
排查问题
Qoder CLI 没有遵守 AGENTS.md
- 运行
/memory,确认目标文件出现在列表中。 - 确认当前目录位于可信工作区内;未信任目录不会加载项目设置、Hooks、MCP 和
AGENTS.md。 - 检查是否存在冲突指令,尤其是用户级、项目级、本地项目级文件之间的冲突。
- 检查
agentsMdExcludes是否排除了目标文件。 - 把笼统要求改成具体、可验证的规则。
@ 导入没有生效
- 确认路径真实存在,并且不是写在 Markdown 代码块或行内代码中。
- 项目外导入默认会被阻止,需要批准外部导入或调整安全设置。
- 对 npm 包名、普通提及和没有文件特征的
@word,Qoder CLI 不会按文件导入处理。
自动记忆没有出现
- 确认当前是 TUI 交互式会话。
- 确认启动时已设置
QODER_MEMORY=1。 - 运行
/memory查看是否出现 auto-memory folder 入口;或运行/memory manage查看自动记忆管理器是否可用。 - 不是每一轮都会保存记忆;没有值得跨会话复用的信息时,创建 0 条记忆是正常结果。