Codex CLI 安装与使用
一句话
在终端里安装 codex(一个基于 OpenAI Codex 模型的开源 CLI),配置 API Key 并设置代理,即可通过自然语言直接让 AI 编写、修改、执行代码。
AI Agent 快速入口
curl -H "Accept: text/markdown" https://doc.k4b.cn/agents/codex-cli-install.md
快速部署(AI 版)
前置条件
- [ ] Node.js 18+(
node -v确认) - [ ] 已注册 OpenAI 账号并获取 API Key(platform.openai.com/api-keys)
- [ ] 终端走代理(例如
export HTTP_PROXY=http://127.0.0.1:7890) - [ ]
npm可用
步骤
# 1. 配置 npm 代理(如已系统全局代理可跳过)
npm config set proxy http://127.0.0.1:7890
npm config set https-proxy http://127.0.0.1:7890
# 2. 全局安装 codex CLI
npm install -g codex
# 3. 设置 OpenAI API Key(建议写入 shell 配置)
export OPENAI_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxx"
# 4. 测试
echo "write a hello world in python" | codex验证
- 终端输出正确的 Python 代码(例如
print("Hello, World!")) - 运行
codex --help显示帮助信息
详细教程(人类版)
背景
Codex CLI(这里特指 codex npm 包)是一个轻量级终端工具,通过管道将自然语言指令传给 OpenAI Codex 模型(code-davinci-002 等),并返回生成的代码。它非常适合快速原型、文件修改、代码补全等场景。由于 OpenAI 的 API 在国内无法直接访问,你需要配置代理才能使用。
第一步:安装 Node.js 18+
建议使用 nvm 管理版本:
# 安装 nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
# 重新加载 shell 或执行 source ~/.bashrc
nvm install 18
nvm use 18验证安装:
node -v # 应输出 v18.x.x第二步:配置终端代理
如果你使用 Clash 等工具,本地代理通常监听 127.0.0.1:7890。在终端执行(可写入 ~/.zshrc 或 ~/.bashrc):
export HTTP_PROXY=http://127.0.0.1:7890
export HTTPS_PROXY=http://127.0.0.1:7890测试代理连通性:
curl -I https://api.openai.com如果返回 HTTP 200 即可。
注意:某些企业网络需要 NTLM 认证,建议使用
proxychains-ng或v2ray的透明代理。
第三步:安装 codex CLI
npm install -g codex安装完成后查看版本:
codex --version如果 npm 安装卡住,可设置 Registry 镜像(但建议保持官方源,仅配代理):
npm install -g codex --registry=https://registry.npmmirror.com但镜像源可能不包含 codex 包,代理方式更稳妥。
第四步:配置 OpenAI API Key
从 API Keys 页面 创建 Key(需要先绑卡)。将 Key 设为环境变量:
export OPENAI_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxx"持久化写入 ~/.zshrc(或 ~/.bashrc):
echo 'export OPENAI_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxx"' >> ~/.zshrc
source ~/.zshrc第五步:基本使用
codex 从标准输入读取提示,输出代码。示例:
- 问问题:
echo "how to reverse a string in Python" | codex - 生成函数:
echo "function that downloads a webpage and extracts all links" | codex - 修改文件:
cat existing.py | echo "add a comment explaining each line" | codex - 执行命令:
echo "run tree on current directory" | codex(注意:不会自动执行,只输出命令)
默认使用 code-davinci-002 模型。可以使用 -m 指定其他模型(如 gpt-3.5-turbo-instruct):
echo "write a bash script to list large files" | codex -m gpt-3.5-turbo-instruct常见问题
Q1:安装失败,报错 403 Forbidden 或超时。
A:检查代理配置是否正确。尝试在终端执行 curl -x http://127.0.0.1:7890 https://api.openai.com 看是否正常。也可临时换用 proxychains:proxychains npm install -g codex
Q2:运行时提示 OPENAI_API_KEY is not set。
A:确认环境变量已生效。在终端执行 echo $OPENAI_API_KEY 查看。如果为空,重新 export 并重新打开终端。
Q3:输出乱码或空行。
A:可能是 API 响应格式异常。可以试试加上 --verbose 参数查看详细请求日志:echo "hello" | codex --verbose。另外检查 API Key 是否过期,或账户余额是否充足。
Q4:能否在 Windows 上使用?
A:codex 基于 Node.js,Windows 同样可用。安装 Node.js 后,使用 cmd 或 PowerShell 运行。注意代理配置需使用 set HTTP_PROXY=http://127.0.0.1:7890。
Q5:是否支持上下文多轮对话?
A:当前 codex 不支持对话历史,每次均为独立请求。如果你需要交互式会话,可以考虑使用 openai 官方的 repl 或 shell_gpt 等工具。
Q6:能不能直接让 AI 修改本地文件?
A:可以结合重定向。先 cat file.js,再通过管道传入修改要求,最后将输出重定向回文件:
cat app.js | echo "add error handling to all async functions" | codex > app_new.js但建议手动确认后再覆盖原文件。