Codex CLI 参考手册

OpenAI Codex CLI 命令行界面完整参考手册，包含所有命令和标志。

CLI 命令

命令	描述	示例
codex	启动交互式代码生成会话	codex
codex "提示"	使用特定提示生成代码	codex "create a Python function"
codex -f file.py	基于文件生成代码	codex -f main.py
codex --explain file.py	解释代码文件	codex --explain utils.js
codex --complete	代码自动补全模式	codex --complete
codex --refactor file.py	重构代码文件	codex --refactor old_code.py
codex update	更新到最新版本	codex update
codex config	配置 API 密钥和设置	codex config

CLI 标志

标志	描述	默认值
-h, --help	显示帮助信息	-
-v, --version	显示版本信息	-
-f, --file	指定输入文件	-
-o, --output	指定输出文件	stdout
-l, --language	指定编程语言	auto-detect
-m, --model	选择 Codex 模型	code-davinci-002
-t, --temperature	设置生成温度	0.1
-n, --max-tokens	最大生成令牌数	150
--explain	解释模式	false
--complete	补全模式	false
--refactor	重构模式	false
--dry-run	预览模式，不执行操作	false

配置选项

环境变量

export OPENAI_API_KEY="your-api-key"
export CODEX_MODEL="code-davinci-002"
export CODEX_MAX_TOKENS="200"

配置文件位置

• Windows: %USERPROFILE%\.codex\config.json
• macOS/Linux: ~/.codex/config.json

使用模式

1. 交互式模式

codex
# 进入交互式会话，可以持续对话

2. 单次查询模式

codex "写一个快速排序函数"
# 生成代码后退出

3. 文件处理模式

codex -f input.py -o output.py --refactor
# 重构指定文件并保存

4. 代码解释模式

codex --explain complex_algorithm.py
# 解释代码逻辑和实现

支持的编程语言

Codex CLI 支持多种编程语言：

• Web 开发: JavaScript, TypeScript, HTML, CSS, React, Vue
• 后端开发: Python, Java, Go, Rust, C++, C#
• 移动开发: Swift, Kotlin, Dart (Flutter)
• 数据科学: Python, R, SQL, Jupyter
• 脚本语言: Bash, PowerShell, Perl
• 其他: YAML, JSON, XML, Dockerfile

最佳实践

1. 清晰的提示

# 好的提示
codex "创建一个 Python 函数，接收用户列表并返回按年龄排序的结果"

# 不够清晰的提示  
codex "排序用户"

2. 指定上下文

# 提供文件上下文
codex -f existing_code.py "添加错误处理"

3. 适当的参数设置

# 对于创造性任务，使用较高温度
codex -t 0.7 "设计一个创新的算法"

# 对于精确任务，使用较低温度
codex -t 0.1 "修复这个 bug"

故障排除

常见错误

1. API 密钥错误: 检查 OPENAI_API_KEY 环境变量
2. 网络连接问题: 验证网络连接和防火墙设置
3. 文件权限错误: 确保有读写文件的权限
4. 模型限制: 检查 API 配额和使用限制

调试模式

codex --verbose "your prompt"
# 显示详细的调试信息

更新和维护

检查更新

codex --version
codex update

清理缓存

codex --clear-cache

---

需要更多帮助？访问 OpenAI Codex 官方文档 或查看我们的 使用教程。