Getting Started
End-to-end setup for first-time users.
Prerequisites
- Node.js 20+ and npm.
- OpenAI Codex CLI installed and authenticated.
- Git (recommended) for project workflows.
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
- Create or enter a project directory.
- Run
omx setupto install prompts, skills, AGENTS.md, and configuration. - Start Codex CLI with
omx. - Try an agent prompt:
/prompts:architect "analyze auth module". - 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
| Issue | What to check |
|---|---|
omx command not found | Re-run global install and ensure npm global bin is in PATH. |
| Prompts not available | Confirm files exist in ~/.codex/prompts/ and re-run omx setup. |
| Skills not loading | Verify ~/.codex/skills/*/SKILL.md files were installed. |
| Doctor reports config issues | Run omx doctor and apply the suggested fixes. |