AGENTS.md 標準起手式：一份能讓任何 AI agent 看懂的最小範本
agents.md 官方標準專案本身的 AGENTS.md，示範一份「最小但完整」的 agent 規則檔長怎樣——告訴 AI 開發時用 dev server 不要 build、依賴變動後重啟、用哪些指令跑 lint/test/build，附可直接改用的繁中範本。
01PROMPT
# AGENTS.md
> 給 AI coding agent（Codex / Claude Code 等）讀的專案指引。目標：讓 agent 不靠猜就知道「平常怎麼開發、怎麼驗證、有哪些指令」。
## Dev environment（最重要的一條）
- Always use `{{DEV_CMD}}` while iterating (e.g. `npm run dev` / `pnpm dev`).
- Do NOT run production builds during agent sessions — they disable hot reload and slow iteration down.
- When in doubt, restart the dev server rather than running a production build.
## Dependencies
- After adding or updating packages, sync the lockfile and restart the dev server so the framework picks up the change.
## Code style
- Prefer {{LANGUAGE}} for new components (e.g. TypeScript).
- Co-locate styles with their component when practical.
- {{EXTRA_STYLE_RULES}}（其他你想讓 agent 遵守的風格規則，沒有可刪）
## Commands
| 目的 | 指令 |
| --- | --- |
| 開發（agent 平常用這個） | `{{DEV_CMD}}` |
| Lint | `{{LINT_CMD}}` |
| 測試 | `{{TEST_CMD}}` |
| 正式打包（agent session 外才用） | `{{BUILD_CMD}}` |
## Notes for the agent
- {{PROJECT_SPECIFIC_NOTE}}（任何專案專屬的注意事項，例：環境變數放哪、哪些目錄別動）把方括號 [ ] 內的變數換成你的內容，丟進 OpenAI Codex。
不用離開網站，直接看這組 prompt 跑出來長怎樣（AI 即時生成，扣 1 點）。
不只複製貼上 — 下載後放到 ~/.codex/prompts/agentsmd-standard-agents-md-starter-template.md，之後輸入 /agentsmd-standard-agents-md-starter-template 一鍵呼叫。
mkdir -p ~/.codex/prompts && mv ~/Downloads/agentsmd-standard-agents-md-starter-template.md ~/.codex/prompts/agentsmd-standard-agents-md-starter-template.mdNew-Item -ItemType Directory -Force "$env:USERPROFILE\.codex\prompts" | Out-Null; Move-Item "$env:USERPROFILE\Downloads\agentsmd-standard-agents-md-starter-template.md" "$env:USERPROFILE\.codex\prompts\agentsmd-standard-agents-md-starter-template.md"02CONTEXT / 使用情境
## 這是什麼／解決什麼痛點 AGENTS.md 是一個開放標準——一份放在專案根目錄、給 AI coding agent 讀的純 Markdown 指引檔，作用相當於「寫給機器的 README」。痛點是：人類看 README，但 AI agent 需要更直接的操作指令（用哪個指令啟動、怎麼測、哪些事別做）。把這些散落在腦袋裡或 Slack 裡的約定集中到一個檔案，agent 就不用猜、也不會每次都問。 ## 為什麼這個來源值得用 這篇策展的是 **agents.md 標準專案倉庫本身的 AGENTS.md**。它的特別之處在於「自帶示範性」——一個推廣標準的專案，自己的 AGENTS.md 自然是「最小但完整」的示範樣板。它不像大型專案那份那麼龐雜，反而非常適合新手當起手式：看一眼就懂一份基本的 AGENTS.md 該有哪幾段。AGENTS.md 作為跨工具的開放格式，Codex、Claude Code 等多家 agent 都會主動讀取，寫一份到處通用。 ## 原檔涵蓋的重點 - **一條核心主規則**：開發時「永遠用 dev server（`npm run dev`）」，不要在 agent session 裡跑 production build——因為 build 會關掉 hot reload、拖慢迭代。這條濃縮成一句金句：「不確定時，重啟 dev server，而不是跑正式打包。」 - **依賴管理**：加/更新套件後，同步 lockfile 並重啟 dev server 讓框架認得新變動。 - **程式碼慣例**：新元件用 TypeScript、樣式盡量與元件放在一起。 - **一張指令表**：`dev`／`lint`／`test`／`build` 各自對應的指令——讓 agent 知道每個目的該打哪個指令。 ## 怎麼用 1. 在 repo 根目錄建 `AGENTS.md`。 2. 套用右側範本，把 `{{DEV_CMD}}`、`{{LINT_CMD}}`、`{{TEST_CMD}}`、`{{BUILD_CMD}}` 換成你專案真實的指令。 3. 把「哪件事 agent 平常該做、哪件事絕對別做」講清楚（這份範本的範例是：用 dev server、別 build）。 4. 之後 Codex／Claude Code 等 agent 進到專案會自動讀它。 ## 何時用 任何新專案的「第一份 agent 文件」。先放這份最小版，等專案長大、慣例變多，再往裡面加測試紀律、模組大小上限、API 命名等規則（可參考另一篇 openai/codex 官方 AGENTS.md 的進階版）。 📎 來源：agentsmd/agents.md 倉庫的 AGENTS.md（版權 © 2025 OpenAI，MIT 授權）— 本篇為繁中改寫整理，原始內容見上方連結。
04VARIABLES / 變數說明
[DEV_CMD]開發伺服器啟動指令，例：npm run dev / pnpm dev
[LANGUAGE]新元件偏好的語言，例：TypeScript
[EXTRA_STYLE_RULES]其他想讓 agent 遵守的程式碼風格規則（可刪）
[LINT_CMD]lint 指令，例：npm run lint
[TEST_CMD]測試指令，例：npm run test
[BUILD_CMD]正式打包指令，例：npm run build（agent session 外才用）
[PROJECT_SPECIFIC_NOTE]專案專屬注意事項，例：環境變數位置、別動的目錄
填下面的欄位，上方 prompt 會即時替換 [方括號] 內容。填好後按「複製組好的 prompt」直接丟進工具。
# AGENTS.md
> 給 AI coding agent（Codex / Claude Code 等）讀的專案指引。目標：讓 agent 不靠猜就知道「平常怎麼開發、怎麼驗證、有哪些指令」。
## Dev environment（最重要的一條）
- Always use `{{DEV_CMD}}` while iterating (e.g. `npm run dev` / `pnpm dev`).
- Do NOT run production builds during agent sessions — they disable hot reload and slow iteration down.
- When in doubt, restart the dev server rather than running a production build.
## Dependencies
- After adding or updating packages, sync the lockfile and restart the dev server so the framework picks up the change.
## Code style
- Prefer {{LANGUAGE}} for new components (e.g. TypeScript).
- Co-locate styles with their component when practical.
- {{EXTRA_STYLE_RULES}}（其他你想讓 agent 遵守的風格規則，沒有可刪）
## Commands
| 目的 | 指令 |
| --- | --- |
| 開發（agent 平常用這個） | `{{DEV_CMD}}` |
| Lint | `{{LINT_CMD}}` |
| 測試 | `{{TEST_CMD}}` |
| 正式打包（agent session 外才用） | `{{BUILD_CMD}}` |
## Notes for the agent
- {{PROJECT_SPECIFIC_NOTE}}（任何專案專屬的注意事項，例：環境變數放哪、哪些目錄別動）「AGENTS.md 標準起手式：一份能讓任何 AI agent 看懂的最小範本」這組提示詞要怎麼用？
這組 prompt 專為 OpenAI Codex 設計。把 prompt 內 7 個方括號 [變數] 換成你自己的內容，貼進 OpenAI Codex 執行即可。難度為入門，新手可以直接套用。
「AGENTS.md 標準起手式：一份能讓任何 AI agent 看懂的最小範本」是免費的嗎？
完整 prompt 免費開放閱讀，不用註冊；可保存瀏覽器收藏，登入後可一鍵複製與留言。
用 OpenAI Codex 依這組 prompt 生成的成果可以商用嗎？
prompt 文字本身你可自由使用與修改。但 AI 生成物（圖／音樂／影片／文字）的商用授權，取決於你在 OpenAI Codex 使用的方案與其官方服務條款，請以該工具的授權規範為準。
RELATED你可能也需要
Suno 工程師思維：4 步驟做出不像 AI 的歌
Studio engineer 視角拆解 Suno 致命弱點（油炸 vocals、高頻 artifact）+ 4 步驟 DAW workflow + Suno Studio 修音 prompt
5 個 6 月 stuck 下來的 Claude 每週 workflow
提案產生器 / 會議處理器 / 內容再利用 / 週五回顧 / 收工 reset — 試了 40 個只有這 5 個沒被丟掉、各省 30+ 分鐘 / 次。
7 個跨 model A/B 測過的 prompt 技巧（不是 vibes）
六個月在 Claude / GPT-4 / Gemini 上用人工 rater A/B 測 200+ prompt 後寫的。包含 persona+constraint stacking / anti-example / role reversal QA / cognitive scaffold / emotional priming / uncertainty CoT / steelman first。
5 個信任檢查單行 prompt（沒有 role-play）
一年的 role-play system prompt + 14-step framework 後總結：真正改變品質的是 5 個單行 prompt。沒有 role、沒有 markdown、沒有「you are an expert」。
EMBED · 嵌入 blog / Note一行 iframe HTML、貼進文章即顯示此 prompt 卡片+
適合：部落格、Medium、Notion 公開頁、Substack — 任何支援 iframe / HTML 嵌入的地方。對方點「看完整」會回到本站、是 prompt 庫的免費 backlink。
<iframe src="https://prompt.luvai.net/embed/agentsmd-standard-agents-md-starter-template" width="100%" height="380" frameborder="0" style="border:1px solid #e0dcd0;border-radius:4px;" loading="lazy" title="PromptCraft Embed"></iframe>