---
title: "AGENTS.md 是给 Agent 的 README"
summary: "它会在开工前自动注入。写清目录、命令、约定、禁止事项和如何验收。"
category: agents-md
level: starter
surfaces: [cli, app, ide, cloud]
tags: ["AGENTS.md", "/init", "约定"]
canonical: /tips/agents-md-readme/
---

# AGENTS.md 是给 Agent 的 README

它会在开工前自动注入。写清目录、命令、约定、禁止事项和如何验收。

一份够用的仓库级 `AGENTS.md` 通常包括：

- 仓库结构和重要目录
- 如何跑起来
- 构建、测试、lint、typecheck 命令
- 工程约定和 PR 期望
- 禁止事项（例如不要改迁移、不要在实现任务里改测试）
- 怎样才算完成

`/init` 能生成骨架，但必须改成你们团队真实的构建、测试、审查和发布方式。

短而准，胜过长而空。从最小集开始，只有重复踩坑才加规则。

## 来源

- [OpenAI · AGENTS.md](https://developers.openai.com/codex/guides/agents-md)