oh-my-codex/docs/getting-started.html at main · Yeachan-Heo/oh-my-codex · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
<!doctype html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Getting Started - oh-my-codex Docs</title>
    <link rel="stylesheet" href="./style.css" />
  </head>
  <body>
    <header>
      <nav class="container nav" aria-label="Primary">
        <a class="brand" href="./index.html">oh-my-codex</a>
        <a href="./index.html">Home</a>
        <a class="active" href="./getting-started.html">Getting Started</a>
        <a href="./agents.html">Agents</a>
        <a href="./skills.html">Skills</a>
        <a href="./integrations.html">Integrations</a>
      </nav>
    </header>

    <main class="container">
      <h1>Getting Started</h1>
      <p class="muted">End-to-end setup for first-time users.</p>

      <h2>Prerequisites</h2>
      <ul>
        <li>Node.js 20+ and npm.</li>
        <li>OpenAI Codex CLI installed and authenticated.</li>
        <li>Git (recommended) for project workflows.</li>
      </ul>

      <h2>Installation</h2>
      <pre><code>npm install -g @openai/codex oh-my-codex
omx setup
omx doctor</code></pre>

      <h2>Recommended Launch</h2>
      <pre><code>omx --xhigh --madmax   # trusted environments
omx                    # standard launch</code></pre>

      <h2>First Run Walkthrough</h2>
      <ol>
        <li>Create or enter a project directory.</li>
        <li>Run <code>omx setup</code> to install prompts, skills, AGENTS.md, and configuration.</li>
        <li>Start Codex CLI with <code>omx</code>.</li>
        <li>Try an agent prompt: <code>/prompts:architect "analyze auth module"</code>.</li>
        <li>Try a workflow skill: <code>$team 3:executor "fix all TypeScript errors"</code>.</li>
      </ol>

      <h2>Prompt Instruction Source</h2>
      <p>OMX layers project instructions by default (extends Codex behavior, does not replace/bypass Codex core system policies):</p>
      <pre><code>-c model_instructions_file="&lt;cwd&gt;/AGENTS.md"</code></pre>
      <p>Override behavior when needed:</p>
      <pre><code>OMX_BYPASS_DEFAULT_SYSTEM_PROMPT=0 omx
OMX_MODEL_INSTRUCTIONS_FILE=/path/to/instructions.md omx</code></pre>

      <h2>Troubleshooting</h2>
      <table>
        <thead><tr><th>Issue</th><th>What to check</th></tr></thead>
        <tbody>
          <tr><td><code>omx</code> command not found</td><td>Re-run global install and ensure npm global bin is in PATH.</td></tr>
          <tr><td>Prompts not available</td><td>Confirm files exist in <code>~/.codex/prompts/</code> and re-run <code>omx setup</code>.</td></tr>
          <tr><td>Skills not loading</td><td>Verify <code>~/.codex/skills/*/SKILL.md</code> files were installed.</td></tr>
          <tr><td>Doctor reports config issues</td><td>Run <code>omx doctor</code> and apply the suggested fixes.</td></tr>
        </tbody>
      </table>
    </main>

    <footer>
      <div class="container">
        <span class="muted">Need broader context? Start from the project README.</span>
      </div>
    </footer>
  </body>
</html>