Codex Installation

Codex 安装指南

5 分钟内在你的项目中通过 OpenAI Codex CLI 安装 ai-coding-ok。

---

前置条件

• 已安装 OpenAI Codex CLI
• 一个项目目录（新建或已有）

---

第 1 步：下载 ai-coding-ok

git clone https://github.com/Mark7766/ai-coding-ok ~/ai-coding-ok

只需执行一次，所有项目共用这一份。

---

第 2 步：全局安装 skill

bash ~/ai-coding-ok/install.sh --codex

这会将 ai-coding-ok skill 安装到 ~/.codex/skills/ai-coding-ok/。每台机器只需执行一次。

---

第 3 步：在项目中初始化

在任意项目中启动 Codex，然后说（记得带一句项目描述）：

安装 ai-coding-ok，我想做一个个人记账工具，记录每天花销和收入

Codex 会进入 Mode A（安装）：

1. 读取 skill 中的模板
2. 将模板复制到当前项目
3. 根据你的一句话描述推断技术栈
4. 填充所有 {{占位符}}
5. 初始化第一条任务历史记录

---

Codex 如何加载 ai-coding-ok

Codex 有两层加载机制：

层级	文件	说明
项目级	AGENTS.md	Codex 自动加载项目根目录的 AGENTS.md，其中包含 PDCA 强制指令
Skill 级	.codex/skills/ai-coding-ok/SKILL.md	Codex skill 入口，定义完整的 PDCA 工作流和安装/升级流程

Codex 还内置 ~/.codex/memories/ 自动记忆系统，与 ai-coding-ok 的三层记忆（project-memory / decisions-log / task-history）互补——前者自动摘要会话，后者人工维护关键决策和项目事实。

---

第 4 步：验证

bash ~/ai-coding-ok/scripts/verify.sh

预期输出：

✓ 所有必需文件已就绪。
✓ 无未填充的占位符 — 安装已完全定制化。

详见安装验证。

---

安装后发生了什么

从此刻起，本项目的每次编码任务都会自动：

1. Plan（规划） — 写代码前读取 AGENTS.md + 3 个记忆文件
2. Do（执行） — 同时写代码和测试
3. Check（检查） — 运行测试，验证无回归
4. Act（记录） — 更新 task-history.md（始终），按需更新 decisions-log.md / project-memory.md

---

与 Claude Code 的差异

方面	Codex	Claude Code
配置文件格式	TOML（~/.codex/config.toml）	JSON（.claude/settings.local.json）
指令文件	AGENTS.md	CLAUDE.md → AGENTS.md
Skill 目录	~/.codex/skills/	~/.claude/skills/
Hard hooks	无	四重 hooks（SessionStart/UserPromptSubmit/PreToolUse/Stop）
自动记忆	~/.codex/memories/（内置）	无（依赖 ai-coding-ok）

---

常见问题

"Codex 的自动记忆和 ai-coding-ok 的记忆冲突吗？"

不冲突，它们是互补的：

• Codex 自动记忆：自动摘要会话，存储在 ~/.codex/memories/
• ai-coding-ok 三层记忆：人工维护关键决策和项目事实，存储在项目的 .github/agent/memory/

"我在用 Windows"

使用 install.py 代替 install.sh：

python ~/ai-coding-ok/install.py --codex

---

下一步

• 验证安装
• 理解 PDCA 工作流
• 了解三层记忆系统