Skip to content

Codex 软件快速上手

Codex 现在更适合直接作为桌面软件使用:打开项目、说明目标、让它完成编码、审查和调试工作。编辑器插件不再是推荐的起点。

选择使用方式

方式适合场景推荐程度
Codex 桌面应用日常项目开发、代码审查、长任务和多任务协作推荐
Codex CLI终端工作流、脚本化操作、使用本站 API Key 和模型分组推荐
Codex Web在浏览器中发起云端任务按需使用
编辑器插件仅在已有团队工作流要求时使用不作为入门方式

1. 安装 Codex 桌面应用

Windows

安装后,从开始菜单打开 ChatGPT,登录你的 ChatGPT 账户,然后进入 Codex。

macOS

打开下载的安装包,将应用移到「应用程序」目录后启动,登录账户并进入 Codex。

Linux

目前请使用 Codex CLICodex Web

TIP

桌面应用用于 ChatGPT 账户登录的工作流。需要使用本站 API Key、模型分组或自定义 config.toml 时,请使用下方的 Codex CLI 配置方式。

2. 在桌面应用中开始项目

  1. 打开 Codex 后,选择本机项目目录,或克隆一个 Git 仓库。
  2. 确认 Codex 可以读取项目文件后,再描述要完成的工作。
  3. 先让它分析计划,再执行涉及多文件或较大范围的修改。
  4. 修改完成后,查看变更、运行测试,并自行确认再提交代码。

可以直接这样开始:

text
阅读这个项目的 README 和现有测试。先说明实现方案和风险;确认后再实现,并运行相关测试。

对于明确的小改动,直接说明目标即可:

text
修复登录页在窄屏下按钮文字溢出的问题,并运行前端测试。

3. 使用 Codex CLI

CLI 适合在终端内直接处理仓库、使用本站 API Key,或切换到特定模型分组。

安装

bash
npm install -g @openai/codex
codex --version

配置 API Key

  1. 登录 控制台,创建或选择 API Key。

  2. 按需要在密钥管理中选择对应分组。

  3. 下载并运行通用 Codex 自动配置脚本:

    脚本会提示输入 API Key,并自动写入 Codex 配置。Windows 双击 .bat 即可;macOS/Linux 在下载目录执行 sh codex-config.sh

  4. 也可以手动编辑 %USERPROFILE%\.codex\config.toml(macOS/Linux 为 ~/.codex/config.toml)。

常用配置教程:

配置完成后,在项目目录运行:

bash
codex

4. 日常使用建议

  • 先说明目标、范围和验收条件,例如“只修改登录模块,并运行相关测试”。
  • 让 Codex 在修改前先阅读 READMEAGENTS.md 和相关模块。
  • 变更较大时,要求它先给出计划,再执行。
  • 提交前检查 diff,并运行项目已有的测试、类型检查或构建命令。
  • 不要将 API Key、密码或生产环境密钥写进提示词、代码或提交记录。

常见问题

桌面应用和 CLI 都要安装吗?

不必。大多数日常开发从桌面应用开始即可;需要本站 API Key、终端自动化或指定模型分组时再安装 CLI。

为什么不推荐从编辑器插件开始?

桌面应用和 CLI 都能直接围绕整个仓库工作,更适合规划、执行和复查完整任务。编辑器插件适合已有固定使用习惯的团队,但不是新用户的必要步骤。

API Key 应该填到哪里?

使用本站 API Key 时,按相应模型教程运行配置脚本。脚本会在本机提示输入密钥;不要把真实 Key 写入配置示例、代码仓库或聊天记录。

桌面应用安装或使用问题在哪里查看?

查看 官方 Codex 桌面应用文档;Windows 用户还可查看 Windows 专项说明