05. 基础配置: General、个性化、AGENTS.md

Codex 的配置分三层:当前对话里的要求、仓库里的 AGENTS.md、全局/项目设置。新手最应该先学 AGENTS.md。

三层配置

层级 适合放什么 举例
当前提示词 这次任务临时要求 “只改 docs 目录”
AGENTS.md 仓库长期约定 测试命令、代码风格、安全边界
全局设置 个人默认偏好 默认语言、权限习惯、模型偏好

AGENTS.md 是什么

AGENTS.md 可以理解为“写给 AI 代理看的 README”。它告诉 Codex:

  • 项目结构。
  • 常用命令。
  • 代码风格。
  • 哪些文件不能碰。
  • 怎么验证完成。
  • 输出格式偏好。

推荐 AGENTS.md 模板

# AGENTS.md

## Project

这是一个 Codex 中文教程站,内容以 Markdown 和静态 HTML 为主。

## Commands

- 本地预览:python3 -m http.server 8765
- 搜索文件:rg "关键词"

## Rules

- 保留原有中转站、购买、飞书教程链接。
- 中文内容保持简洁、可直接发布。
- 不要把 API Key、token、cookie 写入仓库。
- 改动后说明文件列表和验证方式。

## Done

- 新增页面能被链接到。
- Markdown 链接尽量使用相对路径。
- 不引入不必要的网络请求或统计代码。

个性化设置怎么写

适合放:

  • 默认用中文解释。
  • 回答要简洁。
  • 代码改动后列文件。
  • 调试时给假设、实验和最小修复。

不适合放:

  • 密钥。
  • 私人账号密码。
  • 一次性任务要求。
  • 已经过期的下载地址。