Getting Started

End-to-end setup for first-time users.

Prerequisites

Installation

npm install -g @openai/codex oh-my-codex
omx setup
omx doctor

Recommended Launch

omx --xhigh --madmax   # trusted environments
omx                    # standard launch

First Run Walkthrough

  1. Create or enter a project directory.
  2. Run omx setup to install prompts, skills, AGENTS.md, and configuration.
  3. Start Codex CLI with omx.
  4. Try an agent prompt: /prompts:architect "analyze auth module".
  5. Try a workflow skill: $team 3:executor "fix all TypeScript errors".

Prompt Instruction Source

OMX layers project instructions by default (extends Codex behavior, does not replace/bypass Codex core system policies):

-c model_instructions_file="<cwd>/AGENTS.md"

Override behavior when needed:

OMX_BYPASS_DEFAULT_SYSTEM_PROMPT=0 omx
OMX_MODEL_INSTRUCTIONS_FILE=/path/to/instructions.md omx

Troubleshooting

IssueWhat to check
omx command not foundRe-run global install and ensure npm global bin is in PATH.
Prompts not availableConfirm files exist in ~/.codex/prompts/ and re-run omx setup.
Skills not loadingVerify ~/.codex/skills/*/SKILL.md files were installed.
Doctor reports config issuesRun omx doctor and apply the suggested fixes.