用 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 條評論

登入 後參與評論

還沒有評論,來搶沙發~