论坛 1.0.0 初始管理员账号

回复讨论

登录后可参与回复讨论。

Codex 入门教程总结：安装、配置与使用全攻略

原文来源：腾讯云开发者社区
原文主题：Codex 安装、使用与 API Key 配置全流程

一、什么是 Codex？

Codex 是 OpenAI 推出的 AI 编程 Agent（智能体），可以理解为一个能真正"进入项目干活"的 AI 程序员。与普通聊天式 AI（如 ChatGPT）只充当"代码顾问"不同，Codex 具备以下核心能力：

📖 读取项目文件，理解整个代码结构
✏️ 修改代码，完成实际开发任务
▶️ 运行命令，执行构建、测试等操作
🐛 排查错误，定位并修复 Bug

OpenAI 官方对 Codex CLI 的定义是：它可以在你选择的目录中读取、修改并运行代码。

二、Codex 的主要使用方式

使用方式	适合人群	说明
Codex CLI（命令行）	开发者、站长	在终端进入项目目录直接运行 `codex`
Codex App（桌面客户端）	不喜欢命令行的用户	支持 worktree、自动化和 Git 功能
IDE 插件	VS Code / Cursor / Windsurf 用户	融入日常写代码流程

💡 新手建议：从 Codex CLI 开始上手，安装简单、反馈直观。

三、安装前准备

1. 安装 Git

作用：代码管理工具，Codex 在处理项目、生成 diff 时依赖 Git
Windows：从 Git 官网下载安装包，一路 Next 即可
macOS：brew install git
验证：git --version

2. 安装 Node.js

作用：Codex CLI 通过 npm 安装，需要 Node.js 环境
建议：安装 Node.js LTS 长期支持版
验证：node --version 和 npm --version

四、安装 Codex CLI

安装命令

bash
# 推荐方式
npm install -g @openai/codex

# macOS / Linux 权限不足时
sudo npm install -g @openai/codex

⚠️ Windows 用户建议以管理员身份运行终端。

验证安装

bash
codex --version

常见问题：命令未找到

如果安装后 codex 命令无法识别，尝试以下方案：

方案	操作
① 刷新终端	关闭并重新打开终端窗口
② 直接调用	使用 `npx codex` 临时启动
③ 检查路径	`npm bin -g` 确认全局路径已加入环境变量
④ 重装 Node	保持默认路径重新安装 Node.js

五、核心配置：连接 API 聚合平台

配置文件位置

Codex 的配置存放在用户主目录下的 .codex 文件夹中：

系统	路径
Windows	`C:\Users\你的用户名\.codex\`
macOS / Linux	`~/.codex/`

需要创建的两个文件

text
.codex/
├── config.toml    # 主配置文件（接口地址、模型、参数）
└── auth.json      # 鉴权文件（API Key）

📄 文件一：`config.toml`

toml
model = "gpt-5"                    # 默认调用的模型名称
model_provider = "uiuiapi"         # 模型服务商标识
base_url = "https://your-api-endpoint.com/v1"  # API 接口地址

[model_settings]
reasoning_effort = "xhigh"         # 推理强度：xhigh 适合复杂分析
verbosity = "high"                 # 输出详细程度：high 解释更清楚
web_search = true                  # 开启联网搜索
use_responses_api = true           # 使用 Responses API 模式

[auth]
api_key_file = "auth.json"         # 指定鉴权文件

关键参数说明：

参数	说明
`reasoning_effort = "xhigh"`	适合代码分析、重构、Bug 排查等复杂任务
`verbosity = "high"`	新手推荐，输出解释更详细
`web_search = true`	适合查文档、查报错、版本兼容问题
`use_responses_api = true`	适配新版 OpenAI 接口兼容模式

📄 文件二：`auth.json`

json
{
  "api_key": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

⚠️ 安全提醒：

Windows 用户务必确认文件后缀是 .json，不是 .json.txt

在文件资源管理器中开启"显示文件扩展名"以避免错误

六、启动与使用

启动 Codex

bash
# 进入项目目录
cd /path/to/your/project

# 启动交互模式
codex

安全建议

✅ 每次让 Codex 改代码前先 git commit 备份
✅ 改坏后可快速 git reset --hard 回滚
✅ 不要在敏感项目目录中随意授权执行权限

七、文章核心要点总结

维度	关键结论
Codex 定位	不是"代码顾问"，而是"能进项目干活的 AI 程序员"
安装核心	先装 Git + Node.js，再用 npm 全局安装
配置核心	`.codex/config.toml` + `.codex/auth.json` 两个文件
使用原则	先分析 → 再方案 → 确认后修改，不要一上来就大改
最佳实践	Codex + API 聚合平台 = 高效的 AI 编程工作流
安全底线	每次修改前 Git 备份，善用回滚

📌 一句话总结：Codex 是 OpenAI 面向真实软件开发场景推出的 AI 编程助手，配合合理的 API 配置和安全使用习惯，可以极大提升代码阅读、Bug 排查、功能开发和项目重构的效率。

全网最详细的 Codex 入门教程：Codex 安装、使用与获取APIKey 配置全攻略原创

Codex 入门教程总结：安装、配置与使用全攻略

一、什么是 Codex？

二、Codex 的主要使用方式

三、安装前准备

1. 安装 Git

2. 安装 Node.js

四、安装 Codex CLI

安装命令

验证安装

常见问题：命令未找到

五、核心配置：连接 API 聚合平台

配置文件位置

需要创建的两个文件

📄 文件一：`config.toml`

📄 文件二：`auth.json`

六、启动与使用

启动 Codex

推荐的使用流程（新手必看）

安全建议

七、文章核心要点总结

推广广告位

Codex 入门教程总结：安装、配置与使用全攻略

一、什么是 Codex？

二、Codex 的主要使用方式

三、安装前准备

1. 安装 Git

2. 安装 Node.​js

四、安装 Codex CLI

安装命令

验证安装

常见问题：命令未找到

五、核心配置：连接 API 聚合平台

配置文件位置

需要创建的两个文件

📄 文件一：config.​toml

📄 文件二：auth.​json

六、启动与使用

启动 Codex

推荐的使用流程（新手必看）

安全建议

七、文章核心要点总结

推广广告位

2. 安装 Node.js

📄 文件一：`config.toml`

📄 文件二：`auth.json`