AI 编程工具 免费 ⏱ 阅读约 14 分钟 2026/7/9

Codex AGENTS.md

介绍 AGENTS.md 是什么,怎么给 Codex 写项目说明、运行命令和注意事项。

序言

本教程由「小荣的网络开发日志」实操整理编写,实操踩坑验证,内容真实可靠。

遇到操作问题可直接联系作者,转载需标注原文出处,禁止私自篡改商用。

承接网站、APP、小程序、各类脚本定制开发;

AI 编程教学、一对一项目全程陪跑,提供免费技术咨询。

联系方式: 微信:rongyaolg 电话:18375295913


AGENTS.md 是什么

AGENTS.md 是给 Codex 看的项目说明文件。

它可以告诉 Codex:

  • 项目结构
  • 如何安装依赖
  • 如何运行项目
  • 如何运行测试
  • 代码风格
  • 不要做什么

建议写什么

内容 示例
项目说明 这是一个 Astro + Express 项目
安装命令 npm install
启动命令 npm run dev
测试命令 npm test
注意事项 不要改数据库迁移,除非明确要求
完成标准 构建通过,关键功能可运行

快速生成

Codex CLI 中可以使用 /init 作为起点,生成初始 AGENTS.md。

生成后一定要自己检查和补充,不要完全依赖自动生成内容。


官方教程链接