Yeachan-Heo/oh-my-codex

OmX - Oh My codeX: Your codex is not alone. Add hooks, agent teams, HUDs, and so much more.

oh‑my‑codex (OMX) – OpenAI Codex 的工作流层

是什么 – OMX 是一个轻量级的 CLI 包装器,位于官方 OpenAI Codex 命令行工具之上。它不替换 Codex 的代码生成引擎;而是添加了结构化、有明确意见的工作流、持久的项目状态,以及一组可重复使用的“技能”(命令),使日常提示操作更具可重复性。

为何存在 – 许多使用 Codex 的开发者报告称,他们必须重复相同的步骤:明确任务、获取计划、批准计划,然后执行计划。OMX 将这一模式形式化为 $deep‑interview → $ralplan → $ultragoal(可选更严格的变体),并将中间成果物存储在隐藏的 .omx/ 文件夹中。这为您带来:

  • 一个 单一入口点omx),可使用正确的模型设置(高努力推理,可选的“madmax”绕过沙箱检查)启动 Codex 会话,
  • 通过 AGENTS.md 文件实现 项目范围的指导,可合并或独立保留,
  • 持久的日志、计划和检查点,以便恢复或审计长时间运行的重构,
  • macOS/Linux 上的 tmux 基础 UI,将终端分为 HUD 和 Codex 面板,使多面板交互更顺畅。

如何获取

# 如果您已有 Codex CLI(通过 Homebrew、npm 等)
npm install -g oh‑my‑codex
# 否则先安装 Codex
npm install -g @openai/codex
npm install -g oh‑my‑codex

安装后运行一次设置:

omx setup --scope project --merge-agents   # 在您希望 OMX 管理的仓库内运行
# 或
omx setup --scope user                     # 用于全局用户级设置

然后验证一切正常:

omx doctor                     # 检查依赖项和运行时文件
omx exec -C . "Reply with exactly OMX‑EXEC‑OK"   # 对真实 Codex 调用进行烟雾测试

典型工作流

  1. 启动会话(建议在 git worktree 中以实现隔离):
    omx --worktree=feat/task --madmax --xhigh
    
  2. 澄清$deep‑interview "…" – 让 Codex 提出后续问题并完善问题陈述。
  3. 计划$ralplan "…" – 获取具体的架构/实现计划并批准。
  4. 执行 – 以下执行脊柱之一:
    • $ultragoal / $ultrawork – 持久化、带检查点的执行,.omx/ultragoal 中有账本记录。
    • $autopilot – 从访谈到执行的完整监督循环。
    • $ralph – 适用于简单任务的单所有者循环。
    • $prometheus‑strict – 为高风险变更添加额外的批判步骤。
  5. 可选研究$best‑practice‑research$autoresearch$autoresearch‑goal 在计划前拉取外部证据。

核心概念与命令

概念 含义 典型命令
Worktree 用作运行时根目录的隔离 git 检出。 omx --worktree=feature/auth …
MADMAX --dangerously-bypass-approvals-and-sandbox 的快捷方式;禁用 Codex 的安全防护(仅在可信仓库中使用)。
模型努力 --high / --xhigh 设置 model_reasoning_effort,向 Codex 请求更多计算资源。
AGENTS.md 持久化指导文件(全局或项目范围),定义角色、安全规则和路由。
.omx/ 计划、日志、内存快照和账本文件存放的目录。
技能 内置命令快捷方式($deep‑interview$ralplan$ultragoal 等),调用特定 Codex 提示。
团队模式 omx team 启动 tmux 管理的多面板会话,支持并行工作。
直接模式 omx --direct 无 tmux UI 运行 Codex,适合在现有终端中使用。

适用人群

  • 已熟悉 OpenAI Codex CLI 但希望获得可重复、有状态工作流的开发者。
  • 需要 项目级指导(通过 AGENTS.md)并希望保留计划和执行检查点记录的团队。
  • 使用 macOS/Linux 的用户(默认、完全支持路径)。Windows 支持存在但稳定性较低。

限制/注意事项

  • 主要针对 macOS/Linux 优化;Windows 可能出错或行为不一致。
  • “madmax” 标志禁用安全检查 – 仅在可信代码库中使用。
  • OMX 依赖于一个正常工作的、已认证的 codex 二进制文件;它不管理认证本身。
  • 启动时检查更新;可通过 OMX_AUTO_UPDATE 禁用或推迟更新。

项目健康状况

  • 发布于 npm(oh‑my‑codex),版本徽章显示活跃发布。
  • 由原始作者(Yeachan Heo)及小团队贡献者维护。
  • 文档详尽(入门、代理、技能、集成),并提供 Discord 社区支持。

总结 – 如果您已使用 Codex 且发现自己在手动编排提示,OMX 可为您提供现成的、可脚本化的流程、持久状态和更丰富的终端 UI,将临时提示工程转变为可重复的开发流程。

相关

  • Dispatch
  • 项目
  • Dispatch
  • Dispatch
  • Dispatch