返回

oh-my-codex 教程 1:安装配置与快速入门完全指南

详细介绍 oh-my-codex 在各大平台的安装配置方法,包含 --madmax --high 模式详解、AGENTS.md 配置、验证步骤和常见问题排查。

教程概述

本教程将带你完成 oh-my-codex 从零开始的安装配置过程。

你将学到

  • ✅ oh-my-codex 的核心工作原理
  • ✅ 安装和初始化配置
  • --madmax --high 等启动模式详解
  • ✅ AGENTS.md 项目配置
  • ✅ 验证安装是否成功

触发方式标识

trigger_mode: "命令行安装"
codex_native_alternative: "直接使用 codex 命令"
superpowers_equivalent: "Claude Code 的 plugin install"
when_to_use_omx: "Codex CLI 用户,需要工作流增强"
when_to_skip_omx: "Claude Code/Cursor 用户(用 Superpowers)"

安装前准备

系统要求

组件 版本要求 说明
Node.js ≥ 20 必须
Codex CLI 最新版 npm install -g @openai/codex
tmux 最新版 macOS/Linux 团队模式需要

Codex 认证配置

确保 Codex CLI 已正确配置:

# 检查 Codex 是否可用
codex --version

# 测试 Codex 认证
codex "你好"

安装步骤

步骤 1:安装 oh-my-codex

npm install -g oh-my-codex

验证安装:

omx --version
# 输出示例: 0.8.2

步骤 2:运行初始化设置

omx setup

这将执行以下操作:

  • 创建 ~/.omx/ 全局配置目录
  • 安装默认的 /prompts 角色提示
  • 安装工作流技能($plan, $team, $ralph 等)
  • 创建示例 AGENTS.md 文件

启动模式详解

推荐模式:--madmax --high

omx --madmax --high

启动模式对比

模式 命令 说明 适用场景
标准模式 omx 基础功能 简单任务
MadMax omx --madmax 增强提示 复杂分析
High omx --high 高质量输出 代码生成
推荐组合 omx --madmax --high 全部增强 生产使用

AGENTS.md 项目配置

AGENTS.md 是 OMX 的项目指导文件

创建 AGENTS.md

在项目根目录创建 AGENTS.md

# 项目代理指导

## 项目概述
- 项目名称: MyApp
- 技术栈: Next.js + TypeScript + Prisma

## 编码规范
- 使用 TypeScript 严格模式
- 遵循 ESLint 和 Prettier 配置

验证安装成功

测试场景 1:基础命令

omx --help

测试场景 2:启动 OMX

omx --madmax --high

然后输入:

/prompts:architect "分析这个项目的架构"

测试场景 3:工作流技能

$plan "添加用户登录功能"

下一步


📚 完整教程系列导航

你正在阅读本系列的 教程 1,以下是完整目录:

  1. 系列介绍:为 Codex CLI 添加超能力
  2. 教程 1:安装配置与快速入门(当前)
  3. 教程 2:$deep-interview 意图澄清工作流
  4. 教程 3:$plan - 规划驱动的实现路径
  5. 教程 4:/prompts 角色系统详解
  6. 教程 5:$ralph 与持久执行模式
  7. 教程 6:$team 多代理协调
  8. 教程 7:.omx/ 状态管理与 Hooks
  9. 教程 8:HUD、OpenClaw 与自定义技能

上一篇系列介绍:oh-my-codex 教程系列

下一篇教程 2:$deep-interview - 意图澄清工作流