Codex Engineering Rules

轻量、低 Token 的 Codex 工程规则仓库。

30 秒上手

1. 安装全局规则

Windows：

.\scripts\install-global.ps1

macOS / Linux：

./scripts/install-global.sh

默认安装到：

Windows: %USERPROFILE%\.codex\AGENTS.md
macOS/Linux: ~/.codex/AGENTS.md

2. 给项目安装规则

Windows 示例：

.\scripts\install-project.ps1 frontend maintenance D:\Projects\my-app

.\scripts\install-project.ps1 backend java maintenance D:\Projects\my-server

macOS / Linux 示例：

./scripts/install-project.sh frontend maintenance ~/Projects/my-app

./scripts/install-project.sh backend python bootstrap ~/Projects/my-api

3. 正常使用 Codex

直接描述需求：

实现用户列表批量删除。

不需要每次指定任何规则文件。

---

目录

.
├─ global/
│  └─ AGENTS.md
├─ frontend/
│  ├─ bootstrap/AGENTS.md
│  └─ maintenance/AGENTS.md
├─ backend/
│  ├─ node/
│  │  ├─ bootstrap/AGENTS.md
│  │  └─ maintenance/AGENTS.md
│  ├─ java/
│  │  ├─ bootstrap/AGENTS.md
│  │  └─ maintenance/AGENTS.md
│  └─ python/
│     ├─ bootstrap/AGENTS.md
│     └─ maintenance/AGENTS.md
└─ scripts/

项目规则选择

前端 0→1              frontend/bootstrap
前端成熟项目           frontend/maintenance

Node 后端 0→1         backend/node/bootstrap
Node 后端成熟项目      backend/node/maintenance

Java 后端 0→1         backend/java/bootstrap
Java 后端成熟项目      backend/java/maintenance

Python 后端 0→1       backend/python/bootstrap
Python 后端成熟项目    backend/python/maintenance

安装行为

全局和项目安装脚本均为幂等：

• 目标不存在：直接安装。
• 内容相同：跳过，不产生备份。
• 内容不同：先按时间戳备份，再更新。

规则体积检查

Windows：

.\scripts\check-rules.ps1

macOS / Linux：

./scripts/check-rules.sh

默认约束：

• 单个 AGENTS.md 不超过 4 KiB。
• 文件不能为空。
• 文件必须以换行结尾。

这个限制是仓库自己的 Token 预算，不是 Codex 的硬性限制。

设计原则

• Global 只放跨语言通用约束。
• Frontend / Backend 只放各自领域真正特有的规则。
• 后端按语言拆分，不把具体框架写死在目录名。
• Bootstrap 负责 0→1，Maintenance 负责已有项目维护。
• 不在规则中复制项目真实代码和大段文档。
• 规则只保留真正会改变 Codex 决策的内容。