Oh My codeX (OMX) is a workflow layer designed to enhance the user experience of the OpenAI Codex CLI. It's not a replacement for Codex, but rather an augmentation, providing a more structured and efficient environment for interacting with the code generation tool. The primary purpose of OMX is to streamline the process of using Codex, offering a consistent workflow, reusable skills, and project management features. It aims to make Codex sessions stronger from the start and provide runtime assistance as projects grow in complexity.
At its core, OMX introduces a set of specialized roles and skills, accessible through command-line keywords. These keywords, such as `$deep-interview`, `$ralplan`, `$team`, and `$ralph`, represent distinct stages in a typical coding workflow. `$deep-interview` is used to clarify project requirements and boundaries, ensuring a shared understanding before diving into code generation. `$ralplan` facilitates the approval of an implementation plan, allowing users to review and assess potential tradeoffs. `$team` enables coordinated parallel execution of tasks, ideal for larger projects requiring concurrent efforts. Finally, `$ralph` provides a persistent completion loop, allowing a single owner to drive a task to completion.
The repository emphasizes a recommended workflow centered around these keywords. Users are encouraged to start with `$deep-interview` to clarify the scope, then move to `$ralplan` to approve the plan, and finally choose between `$team` for parallel execution or `$ralph` for a persistent completion loop. This structured approach aims to guide users through a more organized and effective coding process.
OMX also incorporates project guidance through scoped `AGENTS.md` files, which can provide context and instructions specific to a project. Furthermore, it utilizes a `.omx/` directory to store project-related data, including plans, logs, memory, and runtime state. This persistent storage helps maintain project context and facilitates debugging and iteration.
The project is primarily designed for macOS and Linux environments, specifically with the Codex CLI. While support for native Windows is available, it is considered a secondary path and may exhibit inconsistencies. The repository provides detailed installation instructions, including the necessary prerequisites like Node.js 20+ and the Codex CLI. It also offers a "quick start" guide that walks users through the initial setup and a basic workflow demonstration. The `omx doctor` command is a crucial tool for verifying the installation and ensuring that all necessary components are correctly configured.
Beyond the core workflow, OMX offers advanced features for more experienced users. The "team runtime" allows for durable coordination using `tmux` (or `psmux` on Windows), enabling parallel execution and persistent state management. Other operator surfaces include `omx setup` for installing and configuring prompts and skills, `omx update` for updating the OMX installation, and `omx hud --watch` for monitoring and status updates. The repository also includes tools like `omx explore` for repository lookup and `omx sparkshell` for shell-native inspection and verification.
The documentation is comprehensive, with guides for getting started, agent catalogs, skill references, troubleshooting, and more. The project also benefits from a strong community, with a Discord server for support and collaboration. The project is actively maintained by a core team and has a growing number of contributors and ambassadors. The project is licensed under the MIT license.
