用 Codex 接手陌生项目:先让它解释代码、列出涉及的文件,再用 /init 起草 AGENTS.md,最后才小步修改,附 4 段提示词

接手别人留下的项目,怎么用 Codex 上手?官方提示指南的做法是先让它解释代码:请求流程、模块职责、校验位置和改动时的坑,并要求列出涉及的文件。再用 /init 起草 AGENTS.md,最后才开始小步修改。本文给 4 段提示词和核对清单。

NNathaniel bigo··原创首发·AI 辅助撰写
7 分钟读完
资料核对于 2026-11-05 · 依据官方文档与公开资料整理 Plus 账号
本文根据 Codex 官方文档《Prompting Codex》《Custom instructions with AGENTS.md》和斜杠命令页整理,资料核对于 2026-11-05。配图为本站整理的示意图,不是软件截图。本站(bigolab.com)不是 OpenAI 官方网站。Codex 的安装和配置见 /guides/codex-getting-started,本文不重复,只讲拿它干活。

适用于谁

  • 刚接手同事留下的仓库,目录和依赖都看不懂的人;
  • 想读开源项目、准备提第一个修改的人;
  • 已经装好 Codex,不知道第一句话该怎么说的人。

结论先说

  1. 别一上来就让它改。 官方示例里“接手”的第一步是 Explain a codebase:让它解释代码,而不是修改。
  2. 问得具体。 官方示例的问法是:请求怎么流转、每个模块负责什么、数据在哪里校验、修改时要注意哪一两个坑。
  3. 让它给你可以核对的东西。 官方的验证方法是要求它给出编号步骤,并列出涉及的文件,你可以逐个打开对照。
  4. 把摸清的规则写进 AGENTS.md。 官方斜杠命令页写明,/init 会为当前项目生成 AGENTS.md 的脚手架,你再改成真正有用的规则。
  5. 然后才小步修改。 一次一个小任务,写清约束和怎么验证。

用 Codex 接手陌生项目的五步:在项目根启动、先解释、列出文件、用 /init 起草 AGENTS.md、再小步修改

图:本站根据 Codex 官方文档《Prompting Codex》 整理的示意图

一、准备:从项目根目录开始

官方示例在命令行里的做法是在仓库根目录启动 codex,用 @(或 /mention)把相关文件的路径放进输入框。在 IDE 里,则是先打开最相关的文件,也可以选中想问的代码,打开的文件会自动作为上下文。

如果你对 Codex 的权限不熟,先看 /guides/codex-permissions-sandbox。接手阶段建议只让它读和解释,不急着放开写入。

二、4 段可以直接复制的提示词

方括号里是要你自己填的内容。

1. 先看整体:这个项目是干什么的

我刚接手这个项目,还没读过代码。请先只读不改,回答:
1. 这个项目是做什么的,主要由哪几个部分组成;
2. 入口文件在哪里,应用怎么启动;
3. 依赖里最重要的 5 个是什么,各自用来做什么;
4. 你不确定的地方请明确说不确定。
最后列出你读过的文件。

2. 追一条具体的流程

请解释 [用户提交订单] 这个请求在代码里是怎么流转的:从哪个入口进来,经过哪些模块,每个模块负责什么,数据在哪里做校验,最后写到了哪里。再说说修改这条流程时需要注意的一两个坑。
请用编号步骤回答,并在每一步后面写出涉及的文件路径。

这个问法对应官方示例里的“Explain a codebase”。拿到答案后,按路径逐个打开文件对照一遍,对不上的地方追问,不要直接信。

3. 起草并完善 AGENTS.md

先在 Codex 里运行 /init,看它生成的初稿。然后用下面的提示词让它补全:

请根据你刚才读过的代码,补全和修订项目根目录的 AGENTS.md。只写你能从代码里确认的内容:
- 怎么安装依赖、启动、运行测试和 lint(写出具体命令);
- 代码风格和目录约定;
- 改动前后必须做的事;
- 哪些文件或目录不要改。
每条尽量短,不要写废话。你不确定的命令,标成“待确认”,不要猜。

官方 AGENTS.md 页给的例子很短,比如“修改 JavaScript 文件后一定运行 npm test”“提交 PR 前运行 npm run lint”“新增生产依赖前先问我”。读取规则和 32 KiB 的上限见 /guides/codex-agents-md-how-it-reads。

4. 做第一个小改动

请做一个小改动:[把某个页面的提示文案从 A 改成 B]。要求:
1. 只改必要的文件,不要重构;
2. 改完说明改了哪些文件;
3. 运行 AGENTS.md 里写的测试命令,并告诉我命令和结果。
改之前先告诉我你打算改哪里。

三、接手阶段要自己核对什么

AGENTS.md 里适合写什么:测试命令、lint 命令、偏好的工具、需要先问的事、文档位置、保持简洁

图:本站根据 Codex 官方文档:AGENTS.md 整理的示意图

  • 它的解释是否和代码一致:这是最容易被忽略的一步。解释里提到的文件和函数,自己打开看一眼;
  • AGENTS.md 里的命令是否真的能跑:自己在终端运行一遍;
  • 不要把密钥、内部地址写进 AGENTS.md,它是会被提交进仓库的文件;
  • 第一个改动用 Git 保护:改动前先确认工作区干净,方便回退;
  • 先确认它是不是在你想要的目录里工作,避免在错误的仓库里修改。

四、一个更稳的接手节奏

下面是本站建议的节奏,不是官方规定,可以按项目大小调整:

  • 第一天只读不改:把“项目是做什么的”“怎么启动”“怎么测试”三个问题弄清楚,并让它把答案写进 AGENTS.md,你自己能把项目跑起来就算过关;
  • 第二天追一两条核心流程:挑最常被改动的功能,如登录、下单、支付回调,用第 2 段提示词追到底,把容易出错的位置记下来;
  • 第三天做一个很小的改动:文案、配置、一个小函数,走通“改、测、提交”的完整流程,确认 Codex 和你的环境配合没问题;
  • 之后再做大改动:重构、升级依赖、改数据库结构这类事,先让它出方案,你确认后再动手。

接手的项目如果没有任何测试,不要急着大改。先让它给关键函数补测试,见 /guides/codex-write-tests-and-run,有了测试的保护,后面的修改才更放心。

常见问题

Q:项目很大,它读不完怎么办?

分模块问。先问整体,再指定一个目录或一条流程,用 @ 指给它。会话变长时可以参考 /guides/codex-cli-commands-cheatsheet 里的命令整理上下文。

Q:/init 生成的内容可以直接用吗?

不建议。它只是脚手架,需要你对照真实命令和团队约定修改。

Q:这些操作会消耗很多额度吗?

读大项目会消耗额度,具体的额度规则见 /guides/codex-usage-limits。Codex 随 ChatGPT 套餐提供,不同套餐的额度以官方页面为准,需要更多额度可以看看 /chongzhi/chatgpt-plus 里的说明。

参考资料

  • Codex 官方文档:Prompting Codex — https://learn.chatgpt.com/docs/prompting
  • Codex 官方文档:Custom instructions with AGENTS.md — https://learn.chatgpt.com/docs/agent-configuration/agents-md
  • Codex 官方文档:Slash commands — https://learn.chatgpt.com/docs/reference/slash-commands

Nathaniel 的更多内容

  1. 01

    Claude Code 在 Windows 上的常见坑:Git Bash 还是 PowerShell、路径反斜杠、假报错、WSL 怎么选

    Windows 上用 Claude Code,装好之后最容易踩的是:用哪个 shell、路径写法不一致、grep 没匹配就报错、钩子没生效、WSL 和原生怎么选。本文逐条按官方文档整理原因和处理办法,附三段提示词和一张对照表。

    Claude0
  2. 02

    Claude Code Hooks 实战「提交前自动跑测试」:PreToolUse 拦住 git commit,测试不过就退出码 2,附 Windows 注意点

    只写一个完整例子:让 Claude Code 每次要执行 git commit 之前,先自动跑项目测试,没通过就拦下并把输出交给它修。本文按官方 Hooks 文档给出脚本、settings.json 配置、测试方法、排错和 Windows 的两处坑。

    Claude0
  3. 03

    Claude Code 自定义斜杠命令与 Skill 实战:从零写一个「生成更新日志」的 /release-notes,含传参、预执行命令和调试

    概念看过了,还是不知道从哪下手?本文按 Claude Code 官方「Extend Claude with skills」写一个完整可用的例子:用 /release-notes 根据 git 记录生成更新日志,覆盖目录、frontmatter、传参、预执行命令、预授权和调试。

    Claude0
  4. 04

    Claude Code 部署网站:先写 Dockerfile 和 compose 在本机跑通,再按清单上云服务器,别让它直接改线上

    想让 Claude Code 帮你把网站部署到云服务器。本文只写通用做法,按 Docker 官方文档讲:让它写 Dockerfile、.dockerignore 和 compose,在本机跑通,端口和数据卷怎么设,再给出上线清单,并说明为什么不要让它直接动线上机器。

    Claude0
  5. 05

    Claude Code 写爬虫与数据清洗:先查 robots.txt 和网站条款,控制频率,原始数据留一份再清洗

    想让 Claude Code 写爬虫抓数据再清洗。本文先讲合规:robots.txt 不是授权也不是安全措施、网站条款要自己读;再讲怎么用 Python 标准库检查规则、小样本先试、保存原始数据,以及用 pandas 清洗,附四段提示词。

    Claude0
  6. 06

    Claude Code 写 Chrome 扩展:按 Manifest V3 起步,加载未打包的扩展,改了哪些文件要重新加载

    想让 Claude Code 帮你写一个 Chrome 扩展。本文按 Chrome 官方扩展文档讲:manifest.json 的最小写法、在 chrome://extensions 加载未打包的扩展、哪些改动要刷新、怎么看控制台和报错,再给四段提示词,以及权限要尽量少。

    Claude0

同产品的其他教程

  1. 01

    OpenAI API 的 token 怎么算、怎么估算费用:input_tokens 计数接口、tiktoken 和隐藏的输出 token

    发请求前想知道会用多少 token?官方有 Responses 的 input_tokens 计数接口,能把文字、图片、文件、工具定义一起算准;本地 tiktoken 只适合纯文本。本文给 Python 和 Node 示例,讲输出 token 为什么可能比看到的多,以及怎么估算费用。

    ChatGPT0
  2. 02

    OpenAI API Node.js / TypeScript 快速上手:npm install openai、example.mjs 第一个请求,到流式、函数调用、联网搜索

    用 Node.js 调 OpenAI API:设置 OPENAI_API_KEY 环境变量,npm install openai,新建 example.mjs,用 client.responses.create 发出第一个请求。并列出图片、文件、流式、函数调用、联网搜索和错误捕获的 Node 写法。

    ChatGPT0
  3. 03

    OpenAI API 用量层级(usage tiers)与速率限制怎么提升:Free、Build、Launch、Grow 和后台 Limits 页

    OpenAI API 的限速不是固定的:官方按累计购买额度把组织分成 Free、Build、Launch、Grow 四个层级,达到门槛自动升级。本文讲 RPM、TPM 等指标、怎么在后台查自己的限额、响应头怎么读、花费上限和限速的区别,以及怎么让限额变得够用。

    ChatGPT0
  4. 04

    OpenAI API 报错 400、401、403、404、429、500、503 怎么排查:按官方错误码页逐个看原因和解决办法

    调用 OpenAI API 返回 400、401、403、404、429、500、503,各自什么意思?本文按官方 Error codes 页,每个状态码一节,写清官方给的原因和解决办法,并说明 404 在官方页面里的位置、429 的六种情形,附 Python 和 Node 的错误捕获写法。

    ChatGPT0
  5. 05

    OpenAI Realtime API 是什么:语音到语音会话、WebRTC 与 WebSocket、临时密钥和事件机制

    Realtime API 让模型直接处理音频,做可以随时打断的语音助手。本文按官方文档讲它是什么、什么时候用、浏览器接入的流程、session 与事件、可用声音、60 分钟会话上限、安全标识,以及它和转写、文字转语音的分工。

    ChatGPT0
  6. 06

    OpenAI 图像生成 API 怎么用:gpt-image 系列、images.generate 与 Responses 工具、尺寸质量和遮罩编辑

    用 OpenAI API 生成或编辑图片,有 Image API 和 Responses 里的 image_generation 工具两条路。本文按官方文档给 Python 和 Node 示例,讲 gpt-image 模型选择、尺寸质量格式参数、遮罩编辑、被拦截时的错误处理,以及需要组织验证的提醒。

    ChatGPT0

0 条评论

登录 后参与评论

还没有评论,来抢沙发~