【Codex技巧】AGENTS.md 应该写什么:项目级指令模板分享

很多人用 Codex 时只改 prompt,但其实项目里的 AGENTS.md 更关键。它相当于给 coding agent 的项目说明书,适合写稳定规则,不适合写一次性需求。 官方入口: Codex 文档: Codex | OpenAI Developers AGENTS.md 文档: https...
【Codex技巧】AGENTS.md 应该写什么:项目级指令模板分享
Codex技巧】AGENTS.md 应该写什么:项目级指令模板分享

很多人用 Codex 时只改 prompt,但其实项目里的 AGENTS.md 更关键。它相当于给 coding agent 的项目说明书,适合写稳定规则,不适合写一次性需求。

官方入口:

我建议 AGENTS.md 写这些

# Project Guide

## Commands
- Install: `pnpm install`
- Dev: `pnpm dev`
- Test: `pnpm test`
- Lint: `pnpm lint`

## Architecture
- Frontend: `src/app`
- Shared UI: `src/components`
- API client: `src/lib/api.ts`
- Tests: `tests/`

## Rules
- Do not change public API shape without updating tests.
- Prefer existing components before creating new ones.
- Keep database migrations backward compatible.
- Do not commit secrets or generated build output.

## Verification
Before finishing, run:
1. `pnpm lint`
2. `pnpm test`

不建议写这些

  1. 大段情绪化描述,比如“你是世界最强工程师”。
  2. 一次性需求,比如“今天帮我改登录页”。
  3. 会频繁变化的计划。
  4. 和项目无关的个人偏好。

这些更适合写在当次对话里。

一个实用技巧

把“验收命令”写进去非常有用。比如:

## Done means
- Unit tests pass.
- Typecheck passes.
- No new console warnings in browser.

这样 Codex 做完任务时会自然知道怎么自检,而不是每次都问“要不要跑测试”。

我的结论

AGENTS.md 不要追求长,追求稳定。

它最好像项目 README 的 agent 版本:告诉模型项目怎么跑、哪里不能乱动、改完怎么验证。

3 个帖子 - 3 位参与者

阅读完整话题

来源: LinuxDo 最新话题查看原文