用途:create-agentsmd 是一段面向代码智能体的提示词,目标是在仓库根目录生成完整、准确的 AGENTS.md 文件,遵循 https://agents.md/ 的公开规范。AGENTS.md 被称为“给智能体看的 README”,用于向 AI 编程工具提供项目上下文与操作指令,与 README.md 互补,填补后者在技术细节上的空缺,并可在 20 多种 AI 编程工具中使用。
主要能力:按规范建议生成若干板块,包括项目概览、安装与环境配置命令、依赖管理、数据库初始化、开发工作流(启动开发服务器、构建命令、监听/热重载)、测试说明(单元、集成、端到端测试的运行方式、测试文件位置与命名、覆盖率要求、运行子集测试的方法)、代码风格细则(语言约定、lint 与格式化、文件组织、命名、导入导出模式)、构建与部署(构建命令与产物目录、环境配置、部署步骤、CI/CD 信息)。还可选补充安全注意事项、monorepo 说明、Pull Request 规范、调试与排错等内容。
使用方式:在目标仓库中调用该提示词,智能体会先分析项目结构(语言与框架、包管理器与构建工具、测试框架、是否为 monorepo),再检查 package.json 脚本、Makefile 或其他构建文件、CI/CD 配置与文档,然后据此写出 AGENTS.md 并核对其中命令是否可用。示例中出现的命令包括 pnpm dlx turbo run where <project_name>、pnpm install --filter <project_name>、pnpm vitest run -t "<test name>" 等,仅作为规范给出的范例,实际内容应依项目而定。
适用场景:单包项目与 monorepo 均可使用;monorepo 可在仓库根放置主文件,并在子项目目录放置额外的 AGENTS.md,就近的文件优先生效。
限制:资料未说明该提示词的收费、价格、平台或效果数据;它是文档生成类提示,不提供项目代码本身的构建能力;生成内容需人工核实命令是否真实可用,并随项目演进持续更新。