Harness-for-codex 是一个语言无关的仓库脚手架,用于让 AI 辅助开发工作流保持一致。它面向 OpenAI Codex、编码智能体、Claude Code 和 Cursor,为智能体驱动的软件工作提供持久的 AGENTS.md 指令、标准自动化入口、任务模板、验证脚本和轻量工作流文档。
用途: 可以将其作为 Codex harness、AGENTS.md 模板或可复用的编码智能体项目脚手架,以便每个后续任务都从可预测的基线开始:
- 通过 AGENTS.md 集中放置智能体指令
- 一个 bootstrap 命令
- 一个 check 命令
- 一个 test 命令
- 一个完整评估命令
- 可选的钩子和 devcontainer 元数据
- 用于记录决策和任务的轻量文档
适用场景:
- 以 Codex 就绪的智能体指令启动新仓库。
- 在 OpenAI Codex、Claude Code 和 Cursor 之间标准化编码智能体工作流。
- 为自动化智能体提供稳定的 setup、check、test 和 handoff 评估命令。
- 将项目决策和任务简报保存在可预测的位置。
- 之后添加语言技术栈,而无需替换 harness 契约。
主要提供内容:
- AGENTS.md:面向 Codex 及兼容智能体的仓库本地操作指令。
- CLAUDE.md:Claude Code 桥接文件,导入共享的 AGENTS.md 指导。
- scripts/bootstrap:在存在已知技术栈时进行依赖准备。
- scripts/check:在可用时执行 lint、格式、类型和测试检查。
- scripts/test:聚焦的测试套件入口。
- scripts/eval:通过 doctor、bootstrap 和 check 完成完整的交接验证。
- tasks/TEMPLATE.md:用于需要持久上下文的工作的任务简报模板。
- docs/decisions.md:未来智能体应保留的持久决策。
使用方式:
- 当工作需要上下文时,在 tasks/ 中编写任务简报。
- 在相关项目文件中实现更改。
- 在 docs/decisions.md 中记录持久决策。
- 完成前运行 scripts/check。
自动化入口:
- scripts/bootstrap:在存在已知技术栈时安装或准备依赖。
- scripts/check:在可用时运行格式化、lint、类型检查和测试。
- scripts/test:在可用时运行测试套件。
- scripts/eval:运行 doctor、bootstrap 和 check 作为交接门禁。
- scripts/doctor:打印仓库和工具就绪状态。
- scripts/hooks:通过 pre-commit 安装可选的本地钩子。
- 如果使用 just,相同命令暴露在 justfile 中。 这些脚本对于空仓库或早期阶段仓库是安全的默认值,可随项目增长而扩展。
兼容的智能体:
- OpenAI Codex 读取 AGENTS.md 获取仓库指令。
- Cursor 可将 AGENTS.md 作为共享项目指导。
- Claude Code 读取 CLAUDE.md,该文件导入相同的共享指令。 将共享规则保留在 AGENTS.md 中,使智能体行为在不同工具间保持一致。仅在工具需要不同桥接时添加工具特定说明。
Harness 元数据: harness.yml 记录规范命令名称、预期文档文件和任务循环阶段。请保持其与 AGENTS.md 及本仓库脚本一致。
可选环境: 仓库包含一个最小 dev container,在创建后运行 scripts/bootstrap。它是可选的;本地开发无需 Docker 也可进行。