Codex CLI 1UP 使用指南
这篇文章将带你完整了解 Codex CLI 1UP —— 一个为 Codex CLI 编码代理扩展强大功能的工具集。本文内容全部基于官方文档,目标是让你在安装、配置和使用过程中少走弯路,同时能快速理解它的作用与价值。
一、Codex CLI 1UP 是什么?
Codex CLI 1UP 的核心目标是为 Codex CLI(@openai/codex
)增加更多实用工具和配置模板,让 AI 编码助手能更高效地完成工作。它的功能点包括:
-
✅ 安装 Codex CLI -
✅ 内置 AST-grep,支持语法级别的精准重构 -
✅ 增强命令行工具: fd
、ripgrep (rg)
、fzf
、jq
、yq
-
✅ 提供 AGENTS.md 模板(generic、typescript、python、shell) -
✅ 提供 Codex CLI 模板(safe、default、yolo) -
✅ 内置 difftastic,让代码 diff 更语义化 -
✅ 提供快捷别名: cx
、cxdiff
⚠️ 注意:该工具面向有经验的用户。如果配置不当,可能会破坏系统。官方测试环境为 macOS + Homebrew + Node.js 22 + zsh,其它环境未保证。安装过程会自动创建备份,但依然需要谨慎操作。
二、为什么需要它?
许多开发者在使用 Codex CLI 时会遇到两个问题:
-
代码重构不够精准 —— 传统 grep
搜索容易出现误伤。 -
代码修改难以追踪 —— 普通 diff 输出不够直观。
Codex CLI 1UP 提供了解决方案:
-
AST-grep:基于语法树的搜索替换,能精准定位代码结构。 -
difftastic:提供语义化的 diff,让 AI 生成的修改更容易审阅。 -
AGENTS.md 模板:帮助 AI 在不同场景下正确选择工具。 -
默认开启 Web 搜索:AI 需要查找资料时能直接联网。
三、快速开始
git clone https://github.com/regenrek/codex-1up
cd codex-1up
./install.sh --yes
# 或者使用封装的命令:
./bin/codex-1up install --yes
安装完成后,打开一个新终端即可开始使用。
四、常用参数说明
参数 | 作用 | |||
---|---|---|---|---|
--yes |
全自动模式,接受默认安全配置 | |||
--dry-run |
只打印执行计划,不做修改 | |||
--skip-confirmation |
跳过确认提示,适合 CI/CD | |||
`–shell auto | zsh | bash | fish` | 指定 Shell 类型 |
--git-external-diff |
将 difftastic 设置为 Git 外部 diff 工具 | |||
--vscode EXT_ID |
安装 VS Code 插件,例如 openai.codex |
|||
--agents-md [PATH] |
输出 AGENTS.md 文件到指定路径 |
|||
--agents-template T |
指定 AGENTS.md 模板:`default |
typescript | python | shell` |
--no-vscode |
跳过 VS Code 插件检测 | |||
`–install-node nvm | brew | skip` | 缺少 Node.js 时的安装方式(默认 nvm) |
五、安装内容概览
安装完成后,你会得到以下组件:
组件 | 作用 |
---|---|
@openai/codex | 核心编码代理,能读、改、运行项目 |
ast-grep | 基于语法树的搜索和替换工具 |
fd | 高速文件查找工具(支持 .gitignore ) |
ripgrep (rg) | 高效的代码全文搜索工具 |
fzf | 模糊搜索工具,快速选择结果 |
jq / yq | JSON / YAML 处理工具 |
difftastic | 语义化代码 diff 工具 |
shell aliases | 快捷命令:cx (快速运行 Codex)、cxdiff (代码对比) |
~/.codex/config.toml | 安装过程生成的配置文件 |
AGENTS.md | 为仓库提供的指令模版 |
六、模板与配置模式
1. AGENTS.md 模板
提供四种场景化模版:
模板 | 适用场景 |
---|---|
default | 通用规则 |
typescript | 针对 TS/TSX 项目 |
python | 针对 Python 项目 |
shell | 针对 Shell 项目 |
2. 配置模式(Profiles)
-
SAFE:最安全 -
DEFAULT:推荐模式 -
YOLO:无提示全开模式 -
NO CHANGES:不写入配置文件
七、安装后该做什么?
-
打开新的终端会话
-
输入
codex
登录账号 -
在项目中尝试运行:
codex
输入指令:
“Plan a refactor for X; then apply and run tests.” -
创建
AGENTS.md
文件:./bin/codex-1up agents --path /path/to/repo --template default
八、FAQ
{
"@context": "https://schema.org",
"@type": "FAQPage",
"mainEntity": [
{
"@type": "Question",
"name": "安装失败怎么办?",
"acceptedAnswer": {
"@type": "Answer",
"text": "检查系统是否具备 Node.js 22,以及是否使用了受支持的包管理器(macOS: Homebrew,Linux: apt/dnf 等)。"
}
},
{
"@type": "Question",
"name": "VS Code 插件安装不成功?",
"acceptedAnswer": {
"@type": "Answer",
"text": "可以添加 --no-vscode 参数跳过插件检测,手动在 VS Code 扩展市场搜索 openai.codex 安装。"
}
},
{
"@type": "Question",
"name": "卸载后怎么彻底清理?",
"acceptedAnswer": {
"@type": "Answer",
"text": "uninstall 命令只会移除别名和 Git 配置。如果要彻底删除依赖,需要手动卸载 @openai/codex 和 @ast-grep/cli。"
}
},
{
"@type": "Question",
"name": "是否支持多语言项目?",
"acceptedAnswer": {
"@type": "Answer",
"text": "支持。你可以根据项目语言选择对应的 AGENTS.md 模板。"
}
},
{
"@type": "Question",
"name": "YOLO 模式安全吗?",
"acceptedAnswer": {
"@type": "Answer",
"text": "YOLO 模式不会询问任何确认,风险最高。只推荐在本地实验环境使用。"
}
}
]
}
九、安装步骤(HowTo)
{
"@context": "https://schema.org",
"@type": "HowTo",
"name": "安装 Codex CLI 1UP",
"step": [
{
"@type": "HowToStep",
"text": "克隆仓库",
"url": "https://github.com/regenrek/codex-1up",
"image": "./public/banner.png"
},
{
"@type": "HowToStep",
"text": "进入目录并运行安装命令",
"url": "https://github.com/regenrek/codex-1up"
},
{
"@type": "HowToStep",
"text": "完成后打开新的终端会话",
"url": "https://github.com/regenrek/codex-1up"
},
{
"@type": "HowToStep",
"text": "输入 codex 并登录账号"
}
]
}
十、总结
Codex CLI 1UP 是 Codex CLI 的增强工具集,重点解决了 代码重构、代码对比和 AI 工具使用一致性 的问题。
它既能帮助 AI 更精准地修改代码,也能让开发者更高效地审查结果。