夜雨聆风学习资料网

ARTICLE · 1062899

【Codex CLI】codex的安装与使用教程

【Codex CLI】codex的安装与使用教程

Codex 是 OpenAI 的 AI 编程代理,可以:

  • 阅读和理解整个代码仓库
  • 根据自然语言生成、修改代码
  • 执行终端命令
  • 运行测试并修复问题
  • 分析报错、重构代码
  • 协助 Git、脚本和 CI 工作流

一、安装 Codex CLI

方式一:官方安装脚本

适用于 macOS 和 Linux:

curl -fsSL https://chatgpt.com/codex/install.sh | bash

安装后检查:

codex --version

方式二:npm 安装

需要先安装 Node.js 和 npm:

npm install -g @openai/codex

升级版本:

npm install -g @openai/codex@latest

方式三:Homebrew 安装

macOS 可以使用:

brew install --cask codex

升级:

brew upgrade --cask codex

Windows

Windows 可以直接使用 Codex 桌面应用或 CLI;如 CLI 兼容性存在问题,可在 WSL 环境中安装:

wsl --install

进入 WSL 后,再运行官方安装脚本或 npm 安装命令。

二、登录 Codex

进入项目目录:

cd /你的项目目录

启动 Codex:

codex

第一次运行时,根据提示选择:

Sign in with ChatGPT

随后在浏览器中完成登录授权。也可以根据终端提供的其他登录方式操作。

三、基本使用

启动交互模式

codex

进入后直接输入任务,例如:

分析这个项目的目录结构,并告诉我如何启动
修复用户登录接口的空指针问题,并补充测试
在新增弹层表单中增加一个支持代码输入的富文本编辑器

启动时直接描述任务

codex "分析当前项目并找出可能的性能问题"

非交互执行任务

适合脚本或 CI:

codex exec "运行测试并总结失败原因"

四、常用命令

codex

启动交互式编程代理。

codex resume

恢复之前保存的会话。

codex exec "任务描述"

以非交互形式执行任务。

codex --image 图片路径

将截图或设计稿作为上下文。

codex --search

允许 Codex搜索最新资料。

codex mcp

查看或配置 MCP 外部工具。

codex completion

生成终端自动补全配置。

codex --help

查看当前版本支持的完整命令。

五、推荐工作流程

首先进入正确的项目目录:

cd ~/projects/my-project

确认 Git 工作区状态:

git status

启动 Codex:

codex

给出明确任务:

请先分析相关代码,不要立即修改。找到问题后说明修改方案,然后修改代码并运行对应测试。不要修改无关文件。

完成后检查改动:

git diff

运行项目测试:

npm test

或者:

mvn test

六、使用注意事项

  • 建议在有 Git 版本管理的项目中使用。
  • 执行前认真检查文件写入范围和终端命令。
  • 涉及删除文件、数据库变更、发布上线时应人工确认。
  • 不要在提示词、源码或日志中提交密码、Token、私钥。
  • 任务描述应包含目标、范围、限制和验收标准。
  • 可在项目中添加 AGENTS.md,告诉 Codex 项目结构、编码规范和测试命令。

官方文档:

Codex CLI:https://developers.openai.com/codex/cli/OpenAI Codex:https://openai.com/codex/

相关学习资料