### Installation and Setup Commands Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/README.md Standard commands for installing, configuring, and verifying the OMX environment. ```bash codex --version ``` ```bash npm install -g oh-my-codex ``` ```bash omx setup --scope project --merge-agents ``` ```bash omx setup --scope user ``` ```bash omx update ``` ```bash omx doctor ``` ```bash codex login status ``` ```bash omx exec --skip-git-repo-check -C . "Reply with exactly OMX-EXEC-OK" ``` ```bash omx --worktree=feat/task --madmax --xhigh ``` -------------------------------- ### Setup oh-my-codex Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/DEMO.md Clones the repository, installs dependencies, and runs the setup command to configure prompts, skills, and the Codex CLI. ```bash # Clone and install git clone https://github.com/Yeachan-Heo/oh-my-codex.git cd oh-my-codex npm install npm run build npm link # Run setup (installs prompts, skills, configures Codex CLI) omx setup ``` -------------------------------- ### Run OMX Setup and Verification Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/plugins/oh-my-codex/skills/omx-setup/SKILL.md Standard commands to initialize the OMX environment and verify the installation status. ```bash omx setup --force --verbose ``` ```bash omx doctor ``` -------------------------------- ### Run Local OMX Entrypoint Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/skills/omx-setup/SKILL.md Executes setup and diagnostic commands using the local bin entrypoint to bypass global installation conflicts. ```bash node bin/omx.js setup --force --verbose node bin/omx.js doctor ``` -------------------------------- ### Initialize OMX Setup Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/skills/omx-setup/SKILL.md Executes the setup process with verbose output and forces an overwrite of existing configurations. ```bash omx setup --force --verbose ``` -------------------------------- ### Initialize Development Environment Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/CONTRIBUTING.md Install dependencies and run standard project checks. ```bash npm install npm run lint npm run build npm test ``` -------------------------------- ### Execute OMX Setup Command Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/plugins/oh-my-codex/skills/omx-setup/SKILL.md Run the setup command with optional flags to configure the environment. ```bash omx setup [--force] [--merge-agents] [--dry-run] [--verbose] [--scope ] [--plugin|--legacy|--install-mode ] ``` -------------------------------- ### Install and test the extension Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/packages/vscode-extension/README.md Install dependencies and run tests within the extension package directory. ```bash cd packages/vscode-extension npm install npm test ``` -------------------------------- ### Canonical workflow example Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/README.md Example commands for managing goals and executing work within the OMX environment. ```text # Copy/pasteable durable-goal example: /goal Ship the checkout bug fix with a durable objective, checkpoints for reproduction, implementation, regression tests, and final verification. $ralplan "approve the checkout bug-fix plan and review tradeoffs" $ultrawork "execute the approved checkout fix with checkpoint evidence" ``` -------------------------------- ### Initialize and verify oh-my-codex Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/docs/index.html Commands to set up the environment and verify the installation status. ```bash omx setup ``` ```bash omx update ``` ```bash omx doctor ``` ```bash omx --xhigh --madmax ``` ```bash omx ``` -------------------------------- ### Package and install VSIX Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/packages/vscode-extension/README.md Package the extension into a VSIX file and install it into the current VS Code instance. ```bash cd packages/vscode-extension npx @vscode/vsce package code --install-extension ./oh-my-codex-vscode-*.vsix --force ``` -------------------------------- ### Configure and Run a Pipeline Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/plugins/oh-my-codex/skills/pipeline/SKILL.md Example of creating a pipeline configuration with standard stages and executing it. ```typescript import { runPipeline, createAutopilotPipelineConfig, createDeepInterviewStage, createRalplanStage, createUltragoalStage, createCodeReviewStage, createUltraqaStage, } from './pipeline/index.js'; const config = createAutopilotPipelineConfig('build feature X', { stages: [ createDeepInterviewStage(), createRalplanStage(), createUltragoalStage(), createCodeReviewStage(), createUltraqaStage(), ], }); const result = await runPipeline(config); ``` -------------------------------- ### CLI Status and Version Commands Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/DEMO.md Manage session state and verify installation details. ```bash # Check version omx version # Check all active modes omx status # Cancel any active mode omx cancel ``` ```text oh-my-codex vX.Y.Z Node.js v20+ Platform: linux x64 ``` ```text No active modes. ``` -------------------------------- ### Add Skill Interaction Example Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/plugins/oh-my-codex/skills/skill/SKILL.md Example interaction for the /skill add command. ```text User: /skill add custom-logger Assistant: Creating new skill 'custom-logger'... Description: Enhanced logging with structured output Triggers (comma-separated): log, logger, logging Argument hint (optional): [message] Scope (user/project): user ✓ Created skill at ~/.codex/skills/custom-logger/SKILL.md → Edit with: /skill edit custom-logger ``` -------------------------------- ### Verify installation and connectivity Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/docs/getting-started.html Run these commands to verify the installation and ensure the active Codex profile can perform requests. ```bash codex login status omx exec --skip-git-repo-check -C . "Reply with exactly OMX-EXEC-OK" ``` -------------------------------- ### Start Codex CLI Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/DEMO.md Initialize the CLI session within a project directory. ```bash omx ``` -------------------------------- ### Launch oh-my-codex sessions Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/docs/getting-started.html Examples of launching sessions with different worktree configurations and security flags. ```bash omx --worktree=feat/task --madmax --xhigh # trusted git repo, named launch worktree omx --worktree=fix/flaky-tests --madmax --xhigh # concurrent trusted session, separate worktree omx # standard launch ``` -------------------------------- ### Install oh-my-codex with npm-managed Codex CLI Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/docs/getting-started.html Use this installation path if you do not have the Codex CLI installed and want npm to manage it. ```bash npm install -g @openai/codex npm install -g oh-my-codex omx doctor ``` -------------------------------- ### Create goals via CLI Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/plugins/oh-my-codex/skills/ultragoal/SKILL.md Commands to initialize goals using brief descriptions, files, or standard input. ```bash omx ultragoal create-goals --brief "" ``` ```bash omx ultragoal create-goals --brief-file ``` ```bash cat | omx ultragoal create-goals --from-stdin ``` ```bash omx ultragoal create-goals --codex-goal-mode per-story --brief "" ``` -------------------------------- ### Install oh-my-codex with existing Codex CLI Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/docs/getting-started.html Use this installation path if the Codex CLI is already installed via Homebrew or another method. ```bash codex --version npm install -g oh-my-codex omx doctor ``` -------------------------------- ### Install tmux dependencies Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/README.md Platform-specific installation commands for tmux or compatible binaries. ```bash brew install tmux ``` ```bash sudo apt install tmux ``` ```bash sudo dnf install tmux ``` ```bash sudo pacman -S tmux ``` ```bash winget install psmux ``` -------------------------------- ### Edit Skill Interaction Example Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/plugins/oh-my-codex/skills/skill/SKILL.md Example interaction for the /skill edit command. ```text User: /skill edit custom-logger Assistant: Current skill 'custom-logger': - Description: Enhanced logging with structured output - Triggers: log, logger, logging - Argument hint: [message] What would you like to edit? (description/triggers/argument-hint/content/rename/cancel) User: triggers Assistant: Current triggers: log, logger, logging New triggers (comma-separated): log, logger, logging, trace ✓ Updated triggers for 'custom-logger' ``` -------------------------------- ### Remove Skill Interaction Example Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/plugins/oh-my-codex/skills/skill/SKILL.md Example interaction for the /skill remove command. ```text User: /skill remove old-logger Assistant: Found skill 'old-logger' in user scope: Description: Legacy logging utility Scope: user (~/.codex/skills/) Delete 'old-logger' skill? (yes/no) User: yes Assistant: ✓ Removed skill 'old-logger' from user scope ``` -------------------------------- ### Serve the generated clone locally Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/skills/web-clone/SKILL.md Commands to start a local server for the generated project to enable testing. ```bash npx serve {output_dir} -l 3456 --no-clipboard ``` ```bash python3 -m http.server 3456 -d {output_dir} ``` -------------------------------- ### Verify installation Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/DEMO.md Runs the doctor command to check the status of the oh-my-codex installation and dependencies. ```bash omx doctor ``` -------------------------------- ### Install oh-my-codex globally Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/docs/index.html Install the package globally via npm to access the CLI commands. ```bash npm install -g oh-my-codex ``` -------------------------------- ### Initialize Skill Directories Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/plugins/oh-my-codex/skills/skill/SKILL.md Checks for and creates the necessary user-level and project-level skill directories if they do not exist. ```bash # Check and create user-level skills directory USER_SKILLS_DIR="$HOME/.codex/skills" if [ -d "$USER_SKILLS_DIR" ]; then echo "User skills directory exists: $USER_SKILLS_DIR" else mkdir -p "$USER_SKILLS_DIR" echo "Created user skills directory: $USER_SKILLS_DIR" fi # Check and create project-level skills directory PROJECT_SKILLS_DIR=".codex/skills" if [ -d "$PROJECT_SKILLS_DIR" ]; then echo "Project skills directory exists: $PROJECT_SKILLS_DIR" else mkdir -p "$PROJECT_SKILLS_DIR" echo "Created project skills directory: $PROJECT_SKILLS_DIR" fi ``` -------------------------------- ### Cost-saving starter configuration Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/docs/reference/omx-config-schema-routing.md A configuration template that routes standard workers to cheaper models and uses the spark lane for low-complexity tasks. ```json { "env": { "OMX_DEFAULT_FRONTIER_MODEL": "gpt-5.6-sol", "OMX_DEFAULT_STANDARD_MODEL": "gpt-5.6-terra", "OMX_DEFAULT_SPARK_MODEL": "gpt-5.6-luna" }, "models": { "default": "gpt-5.6-terra", "team": "gpt-5.6-sol", "team_low_complexity": "gpt-5.6-luna" } } ``` -------------------------------- ### Max-quality starter configuration Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/docs/reference/omx-config-schema-routing.md A configuration template that promotes specific roles to high-quality models and applies explicit reasoning overrides. ```json { "agentModels": { "planner": "gpt-5.6-sol", "architect": "gpt-5.6-sol", "researcher": "gpt-5.6-terra", "explore": "gpt-5.6-luna" }, "agentReasoning": { "planner": "medium", "architect": "xhigh", "researcher": "high", "explore": "medium", "critic": "xhigh" }, "env": { "OMX_DEFAULT_FRONTIER_MODEL": "gpt-5.6-sol", "OMX_DEFAULT_SPARK_MODEL": "gpt-5.6-luna" }, "models": { "default": "gpt-5.6-sol", "team": "gpt-5.6-sol", "autopilot": "gpt-5.6-sol", "ralph": "gpt-5.6-sol", "team_low_complexity": "gpt-5.6-luna" } } ``` -------------------------------- ### Install Codex and oh-my-codex via npm Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/README.md Use these commands to install the required Codex CLI and the oh-my-codex package globally. ```bash npm install -g @openai/codex npm install -g oh-my-codex ``` -------------------------------- ### Sparkshell and Explore Help Commands Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/docs/qa/explore-sparkshell-heavy-manual-stress.md Baseline commands to verify the availability and help documentation of the sparkshell and explore modules. ```bash node bin/omx.js sparkshell --help node bin/omx.js explore --help ``` -------------------------------- ### Quick Add Wiki Page Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/plugins/oh-my-codex/skills/wiki/SKILL.md Quickly creates a new wiki page with specified metadata. ```bash omx wiki wiki_add --input '{"title":"Page Title","content":"...","tags":["tag1"],"category":"decision"}' --json ``` -------------------------------- ### Create a new project plan Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/docs/ultragoal.md Initializes a new project plan using a brief provided via string, file, or standard input. Supports configuring the goal mode to aggregate or per-story. ```sh omx ultragoal create-goals --brief "Ship the feature in three safe milestones" omx ultragoal create-goals --brief-file docs/my-brief.md cat docs/my-brief.md | omx ultragoal create-goals --from-stdin omx ultragoal create-goals --codex-goal-mode per-story --brief "Use one Codex goal context per story" ``` -------------------------------- ### Build and Local Execution Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/plugins/oh-my-codex/skills/omx-setup/SKILL.md Commands for building the project from source and running the local entrypoint for troubleshooting. ```bash npm run build ``` ```bash node bin/omx.js setup --force --verbose ``` ```bash node bin/omx.js doctor ``` -------------------------------- ### Team Skill Invocation Examples Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/plugins/oh-my-codex/skills/team/SKILL.md Common usage patterns for the team command. ```bash omx team 3:executor "analyze feature X and report flaws" omx team "debug flaky integration tests" omx team "ship end-to-end fix with verification" ``` -------------------------------- ### Minimal HUD Preset Output Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/plugins/oh-my-codex/skills/hud/SKILL.md Example output for the minimal HUD preset. ```text [OMX] ralph:3/10 | turns:42 ``` -------------------------------- ### Build project Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/docs/qa/release-readiness-0.18.16.md Compiles the project source code. ```bash npm run build ``` -------------------------------- ### Verify command baseline Source: https://github.com/yeachan-heo/oh-my-codex/blob/main/docs/qa/explore-sparkshell-heavy-manual-stress.md Standard commands for verifying the installation and functionality of the omx toolset. ```bash node bin/omx.js explore --help ``` ```bash node bin/omx.js sparkshell --help ``` ```bash node bin/omx.js sparkshell git --version ``` ```bash node bin/omx.js version ```