OpenAI Codex CLI 安装与配置指南

OpenAI Codex CLI 安装与配置指南

codex Lightweight coding agent that runs in your terminal 项目地址: https://gitcode.com/gh_mirrors/codex31/codex

1. 项目基础介绍

OpenAI Codex CLI 是一个轻量级编码代理，它可以在您的终端中运行。它是为那些已经在终端中工作并且希望获得 ChatGPT 级别推理能力，加上实际运行代码、操作文件和迭代能力的开发者设计的。简而言之，它是一种聊天驱动的开发方式，能够理解和执行您的代码库。

主要编程语言：JavaScript

2. 项目使用的关键技术和框架

• OpenAI API：Codex CLI 使用 OpenAI 的 API 来实现智能编码功能。
• Node.js：项目使用 Node.js 作为运行时环境。
• 终端交互：通过与终端的交互，用户可以输入命令和代码提示，Codex CLI 将根据这些提示执行相应的操作。

3. 安装和配置准备工作

在开始安装 Codex CLI 之前，请确保您的系统满足以下要求：

• 操作系统：macOS 12+、Ubuntu 20.04+/Debian 10+ 或 Windows 11 (通过 WSL2)
• Node.js：22 或更新版本（推荐使用 LTS 版本）
• Git（可选，推荐）：2.23+ 以支持内置的 PR 辅助功能
• 内存：至少 4GB（推荐 8GB）

确保您的系统中已经安装了 Node.js 和 Git。您可以通过在终端中运行以下命令来检查它们是否已经安装：

node -v
git -v

如果这些命令返回版本号，那么您的系统已经准备好了。如果它们没有返回版本号，您需要先安装 Node.js 和 Git。

安装步骤

1. 全局安装 Codex CLI

   在您的终端中，运行以下命令来全局安装 Codex CLI：

   npm install -g @openai/codex
   

2. 设置 OpenAI API 密钥

   为了使 Codex CLI 能够工作，您需要设置一个环境变量来存储您的 OpenAI API 密钥。在终端中，运行以下命令：

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

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

3. 开始使用 Codex CLI

   现在，您可以使用以下命令开始与 Codex CLI 交互：

   codex
   

   或者，您可以提供一个提示作为输入，并选择性地使用 Full Auto 模式：

   codex "explain this codebase to me"
   codex --approval-mode full-auto "create the fanciest todo-list app"
   

   这就是 OpenAI Codex CLI 的基本安装和配置流程。现在您可以开始探索它的功能，并使用它来提高您的开发效率了。

codex Lightweight coding agent that runs in your terminal 项目地址: https://gitcode.com/gh_mirrors/codex31/codex