跳到主要内容
OMX (Oh My Codex) · prolist
返回项目库查看仓库原始简介 OmX - Oh My codeX: Your codex is not alone. Add hooks, agent teams, HUDs, and so much more.
项目解读 README
项目解读由 AI 根据历史资料整理,尚未经人工复核。仓库资料更新于 2026-09-08,与历史解读分开保留。
项目概览 OMX(Oh My Codex)是 OpenAI Codex CLI 的工作流增强层,它不替代 Codex,而是在其上叠加结构化工作流、多 Agent 协作、持久化状态管理和专业角色系统。它主要解决 Codex CLI 缺乏结构化工作流、多任务并行时缺少团队协调机制、项目状态与计划无法跨会话持久化、缺少专业角色分工等问题。其核心是四个 Skill:$deep-interview 用于澄清需求边界,$ralplan 用于生成并审批实现计划,$ralph 用于单人持续执行到完成,$team 用于基于 tmux 的多 Agent 并行执行。所有计划、日志、记忆和运行时状态都持久化在项目本地的 .omx/ 目录中,并通过 Codex 原生的 .codex/hooks.json 机制集成。OMX 主要针对 macOS/Linux 平台优化,并锁定 OpenAI Codex 生态。
解决什么问题 OMX 主要解决直接使用 Codex CLI 时遇到的五类结构性痛点:一是需求模糊就开干,缺少“先澄清、后执行”的结构化流程,容易浪费 Token 和时间;二是计划没有版本管理,跨会话的计划追踪依赖复制粘贴,修改历史不可追溯;三是单 Agent 无法并行,大型项目需要同时修改多个文件时效率低下;四是没有专业角色分工,同一个会话既要理解需求、设计架构、写代码、跑测试,角色混乱导致输出质量不稳定;五是状态不持久化,会话结束后所有上下文丢失,跨会话工作衔接全靠手动。
工作方式 OMX 的核心是四个 Skill,每个解决一个特定阶段的问题。$deep-interview 通过结构化提问逐步收敛模糊需求到一个可执行的 Scope;$ralplan 将澄清后的 Scope 转化为可审批的架构和实现计划,等待人工审批;$ralph 是一个人工 Owner 持续推进到完成的持久化完成与验证循环;$team 基于 tmux 创建多个 Codex 会话,每个 Agent 在独立窗格中工作,Leader 协调分工。OMX 通过关键词检测器识别以 $ 开头的输入并路由到对应 Skill,通过 .codex/hooks.json 注册原生 Codex Hook 在生命周期节点插入逻辑,所有计划、日志、记忆和运行时状态持久化在 .omx/ 目录下。
核心能力
强制“先澄清→后计划→再执行”的结构化工作流
基于 tmux 的多 Agent 并行执行,适合大型任务
omx/ 目录跨会话持久化状态,支持断点续传
不替换 Codex,是轻量增强层,可随时移除
$ 关键词触发预设角色,不同阶段有专业视角
通过 Codex 原生 Hook 机制集成,非 hack 方式
使用前需要了解
AI 整理 · 本地测试,未经人工复核;依据历史报告节选,不代表当前产品状态。
OMX 必须依赖 OpenAI Codex CLI 才能运行,无法切换到 Claude 或 Gemini 等其他模型。它主要针对 macOS/Linux 平台优化,Windows 不是默认体验,团队运行时需要 tmux,Windows 上替代方案支持有限。OMX 完全围绕代码工作流设计,不适合非编程场景,也不适合只需要快速修改一行代码的简单任务。Codex CLI 本身的限制(如 API 速率限制、模型能力上限)也会传导到 OMX。
build
cargo fmt --check
cargo clippy -- -D warnings
首次会话 $deep-interview "clarify the auth change"
$ralplan "approve the auth plan and review tradeoffs"
$ultragoal "carry the approved plan to completion"
$team 3:executor "execute the approved plan in parallel"
omx team 4:executor "parallelize a multi-module refactor"
omx team status <team-name>
omx team shutdown <team-name>
推荐工作流
$deep-interview — 当范围或边界还不清楚时,先用它澄清需求。
$ralplan — 把澄清后的范围整理成可批准的架构与实施计划。
$team 或 $ultragoal — 需要协调并行执行时用 $team,需要持久记录目标并推进到完成时用 $ultragoal。
核心模型 User
-> Codex CLI
-> AGENTS.md (编排大脑)
-> ~/.codex/prompts/*.md (代理 prompt 目录)
-> ~/.codex/skills/*/SKILL.md (skill 目录)
-> ~/.codex/config.toml (功能、通知、MCP)
-> .omx/ (运行时状态、记忆、计划、日志)
主要命令 omx # 启动 Codex(在 tmux 中附带 HUD)
omx setup # 按作用域安装 prompt/skill/config + 项目 .omx + 作用域专属 AGENTS.md
omx doctor # 安装/运行时诊断
omx doctor --team # Team/swarm 诊断
omx team ... # 启动/状态/恢复/关闭 tmux 团队 worker
omx status # 显示活动模式
omx cancel # 取消活动执行模式
omx reasoning <mode> # low|medium|high|xhigh
omx tmux-hook ... # init|status|validate|test
omx hooks ... # init|status|validate|test(插件扩展工作流)
omx hud ... # --watch|--json|--preset
omx help
Hooks 扩展(附加表面) OMX 现在包含用于插件脚手架和验证的 omx hooks。
omx tmux-hook 继续支持且未更改。
omx hooks 是附加的,不会替代 tmux-hook 工作流。
插件文件位于 .omx/hooks/*.mjs。
插件默认关闭;使用 OMX_HOOK_PLUGINS=1 启用。
完整的扩展工作流和事件模型请参阅 docs/hooks-extension.md。
启动标志 --yolo
--high
--xhigh
--madmax
--force
--dry-run
--verbose
--scope <user|project> # 仅用于 setup
--madmax 映射到 Codex --dangerously-bypass-approvals-and-sandbox。
仅在可信/外部沙箱环境中使用。
MCP workingDirectory 策略(可选加固) 默认情况下,MCP state/memory/trace 工具接受调用方提供的 workingDirectory。
要限制此行为,请设置允许的根目录列表:
export OMX_MCP_WORKDIR_ROOTS="/path/to/project:/path/to/another-root"
设置后,超出这些根目录的 workingDirectory 值将被拒绝。
Codex-First Prompt 控制 -c model_instructions_file="<cwd>/AGENTS.md"
这会将 CODEX_HOME 中的 AGENTS.md 与项目 AGENTS.md(如果存在)合并,然后再附加运行时 overlay。
扩展 Codex 行为,但不会替换/绕过 Codex 核心系统策略。
OMX_BYPASS_DEFAULT_SYSTEM_PROMPT=0 omx # 禁用 AGENTS.md 注入
OMX_MODEL_INSTRUCTIONS_FILE=/path/to/instructions.md omx
团队模式 对于受益于并行 worker 的大规模工作,使用团队模式。
start -> assign scoped lanes -> monitor -> verify terminal tasks -> shutdown
omx team <args>
omx team status <team-name>
omx team resume <team-name>
omx team shutdown <team-name>
重要规则:除非中止,否则不要在任务仍处于 in_progress 状态时关闭。
Team shutdown policy Use omx team shutdown <team-name> after the team reaches a terminal state.
Team cleanup now follows one standalone path; legacy linked-Ralph shutdown handling is no longer a separate public workflow.
团队 worker 的 Worker CLI 选择:
OMX_TEAM_WORKER_CLI=auto # 默认;当 worker --model 包含 "claude" 时使用 claude
OMX_TEAM_WORKER_CLI=codex # 强制 Codex CLI worker
OMX_TEAM_WORKER_CLI=claude # 强制 Claude CLI worker
OMX_TEAM_WORKER_CLI_MAP=codex,codex,claude,claude # 每个 worker 的 CLI 混合(长度=1 或 worker 数量)
OMX_TEAM_AUTO_INTERRUPT_RETRY=0 # 可选:禁用自适应 queue->resend 回退
Worker 启动参数仍通过 OMX_TEAM_WORKER_LAUNCH_ARGS 共享。
OMX_TEAM_WORKER_CLI_MAP 覆盖 OMX_TEAM_WORKER_CLI 以实现每个 worker 的选择。
触发器提交默认使用自适应重试(queue/submit,需要时使用安全的 clear-line+resend 回退)。
在 Claude worker 模式下,OMX 以普通 claude 启动 worker(无额外启动参数),并忽略显式的 --model / --config / --effort 覆盖,使 Claude 使用默认 settings.json。
omx setup 写入的内容
.omx/setup-scope.json(持久化的设置作用域)
依赖作用域的安装:
user:~/.codex/prompts/、~/.codex/skills/、~/.codex/config.toml、~/.omx/agents/、~/.codex/AGENTS.md
project:./.codex/prompts/、./.codex/skills/、./.codex/config.toml、./.omx/agents/、./AGENTS.md
启动行为:如果持久化的作用域是 project,omx 启动时自动使用 CODEX_HOME=./.codex(除非 CODEX_HOME 已设置)。
启动指令会合并 ~/.codex/AGENTS.md(或被覆盖的 CODEX_HOME/AGENTS.md)与项目 ./AGENTS.md,然后附加运行时 overlay。
现有 AGENTS.md 文件绝不会被静默覆盖:交互式 TTY 下 setup 会先询问是否替换;非交互模式下除非传入 --force,否则会跳过替换(活动会话安全检查仍然适用)。
config.toml 更新(两种作用域均适用):
notify = ["node", "..."]
model_reasoning_effort = "medium"
developer_instructions = "..."
[features] multi_agent = true, child_agents_md = true
MCP 服务器条目(omx_state、omx_memory、omx_code_intel、omx_trace、omx_wiki(仓库 Wiki 服务器)、omx_hermes(有界的会话状态/协调桥接))
[tui] status_line
作用域专属 AGENTS.md
.omx/ 运行时目录和 HUD 配置
代理和技能
Prompt:prompts/*.md(user 安装到 ~/.codex/prompts/,project 安装到 ./.codex/prompts/)
Skill:skills/*/SKILL.md(user 安装到 ~/.codex/skills/,project 安装到 ./.codex/skills/)
代理:architect、planner、executor、debugger、verifier、security-reviewer
技能:deep-interview、ralplan、team、ultragoal、plan、cancel
项目结构 oh-my-codex/
bin/omx.js
src/
cli/
team/
mcp/
hooks/
hud/
config/
modes/
notifications/
verification/
prompts/
skills/
templates/
scripts/
开发 git clone https://github.com/Yeachan-Heo/oh-my-codex.git
cd oh-my-codex
npm install
npm run build
npm test
文档
完整文档 — 完整指南
CLI 参考 — 所有 omx 命令、标志和工具
通知指南 — Discord、Telegram、Slack 和 webhook 设置
推荐工作流 — 用于常见任务的经过实战检验的 skill 链
发行说明 — 每个版本的新功能
备注
完整变更日志:CHANGELOG.md
迁移指南(v0.4.4 后的 mainline):docs/migration-mainline-post-v0.4.4.md
覆盖率和对等说明:COVERAGE.md
Hook 扩展工作流:docs/hooks-extension.md
设置和贡献详情:CONTRIBUTING.md
致谢
语言
许可证 09.08