开源项目 Codex CLI 使用教程

1. 项目介绍

Codex CLI 是一个轻量级的编码代理，它可以在您的终端中运行。该项目是基于 OpenAI 的 Codex 项目的一个分支，支持多种 AI 提供商（OpenAI、Gemini、OpenRouter、Ollama），并使用 Chat Completion API，允许与任何兼容 openai 的提供者和模型进行交互。Codex CLI 是一个实验性项目，目前仍在积极开发中，它旨在为开发者提供一种在终端中通过聊天驱动的开发体验。

2. 项目快速启动

要全局安装 Codex CLI，请在终端中运行以下命令：

npm install -g open-codex

安装完成后，设置您的 API 键为环境变量。以下以 OpenAI 为例：

export OPENAI_API_KEY="your-api-key-here"

请注意，这个命令仅对当前终端会话有效。要永久设置，请将 export 行添加到您的 shell 配置文件中（例如 ~/.zshrc）。

启动 Codex CLI 的交互模式，只需在终端中运行：

open-codex

或者，如果您想提供一个输入提示（并可选择开启全自动模式），可以使用以下命令：

open-codex "解释这个代码库给我听" --approval-mode full-auto

3. 应用案例和最佳实践

以下是使用 Codex CLI 的一些典型场景：

• 代码重构：codex "重构 Dashboard 组件为 React Hooks"
• 数据库迁移：codex "为添加用户表生成 SQL 迁移"
• 单元测试：codex "为 utils/date.ts 编写单元测试"
• 文件重命名：codex "批量重命名 *.jpeg 为 *.jpg 使用 git mv"
• 正则表达式解释：codex "解释这个正则表达式：^(?=.*[A-Z]).{8,}$"
• 代码审查：codex "仔细审查这个仓库，并提出 3 个高影响力的 PR"

4. 典型生态项目

Codex CLI 作为编码助手，可以与多种类型的开源项目集成。以下是一些可能与之配合使用的典型生态项目：

• 前端框架：如 React、Vue、Angular 等，Codex CLI 可以帮助快速生成组件和代码片段。
• 后端框架：如 Express、Koa、Django 等，Codex CLI 可以辅助生成路由、控制器和模型。
• 数据库工具：如 MySQL、PostgreSQL、MongoDB 等，Codex CLI 可以生成数据库迁移脚本和查询语句。

通过以上介绍，您可以开始使用 Codex CLI 来提升您的开发效率。在实验和使用的过