用途:初始化或更新项目约定,让编码智能体更有效地在仓库中工作。内置可复用的项目规则模板 templates/AGENTS.md,作为标准基线,先复制再按仓库实际调整,不要凭记忆重建。核心原则是保持 AGENTS.md 精简,但不要删掉模板中的标准护栏。只写仓库或技术栈专属规则;若能力强的智能体一分钟内能从代码推断出来,就省略,除非该规则能防止常见错误。
主要能力:依据仓库证据做决策并编辑。安装模式(无 AGENTS.md 但已有代码和包元数据)复制模板后适配;更新模式(已存在)以现有文件为基底打补丁,补齐缺失的标准段,不整体重写。标准段包括 Package Manager、Documentation、Documentation Conventions(含 Design-doc statuses)、Testing Expectations、Safety。
使用方式:先检查仓库,命令示例:rg --files -g 'AGENTS.md' -g 'README.md' -g 'package.json' -g 'bun.lock' -g 'pnpm-lock.yaml' -g 'yarn.lock' -g 'package-lock.json' -g '.npmrc' -g '.nvmrc' -g '.node-version';若 docs/ 存在则 find docs -maxdepth 3 -type f。检查 package.json 的 scripts、dependencies、packageManager、workspaces,以及框架配置(next.config.、vite.config.、tsconfig.json、turbo.json 等)。据锁文件与元数据判定包管理器:bun.lock 或 packageManager 为 bun 用 Bun;pnpm-lock.yaml 用 pnpm;yarn.lock 用 Yarn;package-lock.json 用 npm;pyproject.toml 配 Poetry 或 poetry.lock 用 Poetry。多信号时报告歧义并提一个聚焦问题。新项目可问少量焦点问题(目标、类型、技术栈、约束、是否建轻量文档),种子文档可放 docs/vision/vision.md、docs/architecture/architecture.md、docs/architecture/tech-stack.md,只建当前适用的。命令段优先用包脚本,缺失就省略,不要留占位符或“稍后补充”。
适用场景与限制:需避免通用建议(如“写干净代码”“加测试”)、长架构解释、明显目录清单、无证据照搬他项目规则。提交的文档和 AGENTS.md 中不得保留尖括号占位符。若仓库已有不同文档约定,应保留并说明真实事实来源,不强行套用模板结构。资料未提供具体价格、平台、版本等,均暂未提供。