Skip to content

Codex CLI 快速入门

欢迎使用 Codex CLI!本教程将在 5 分钟内带您快速上手,学会使用 Codex CLI 进行高效的代码生成和补全。

🎯 学习目标

通过本教程,您将学会:

  • 执行第一个代码生成命令
  • 理解基本的命令行语法
  • 使用不同的代码生成模式
  • 配置个性化设置

🚀 第一步:验证安装

如需安装 Codex CLI,请先参考 安装指南

确保 Codex CLI 已正确安装:

bash
codex --version

✨ 第二步:生成第一段代码

让我们从最简单的代码生成开始:

bash
# 生成 Python Hello World 函数
codex generate "create a hello world function" --lang python

您应该看到类似这样的输出:

python
def hello_world():
    """Print Hello, World! to the console."""
    print("Hello, World!")

# 调用函数
hello_world()

🎉 恭喜! 您刚刚生成了第一段代码!

📚 基本命令语法

Codex CLI 的基本语法格式为:

bash
codex [命令] [描述] [选项]

核心命令

命令功能
"提示文本"基础代码生成
-f file基于文件生成
--explain代码解释

完整命令列表和选项请参考 CLI 参考手册

💡 实践练习

练习 1:生成不同语言的函数

试试生成相同功能但不同语言的代码:

bash
# Python 版本
codex generate "calculate fibonacci number" --lang python

# JavaScript 版本
codex generate "calculate fibonacci number" --lang javascript

# Go 版本
codex generate "calculate fibonacci number" --lang go

练习 2:代码补全

创建一个不完整的代码文件,然后使用补全功能:

python
# 创建 example.py
def calculate_area(radius):
    # TODO: 计算圆的面积
bash
# 使用 Codex 补全
codex complete --file example.py --line 2

练习 3:解释现有代码

bash
# 解释复杂的代码片段
codex explain --code "lambda x: x**2 if x > 0 else 0"

🛠️ 常用使用模式

1. 快速原型开发

bash
# 生成 REST API 端点
codex generate "create REST API endpoint for user management" --lang python --style flask

# 生成数据库模型
codex generate "create User model with name, email, age fields" --lang python --style sqlalchemy

2. 算法实现

bash
# 生成排序算法
codex generate "implement quicksort algorithm with comments" --lang python

# 生成搜索算法
codex generate "binary search implementation" --lang java

3. 测试用例生成

bash
# 为函数生成测试用例
codex generate "unit tests for fibonacci function" --lang python --style pytest

4. 文档生成

bash
# 生成函数文档
codex docs --function calculate_total --format docstring

⚙️ 个性化配置

设置默认语言

bash
# 设置默认编程语言
codex config set default_language "python"

# 现在可以省略 --lang 参数
codex generate "create list comprehension example"

自定义代码风格

bash
# 设置代码风格偏好
codex config set code_style "clean"
codex config set max_lines 50
codex config set include_comments true

配置输出格式

bash
# 设置输出格式
codex config set output_format "markdown"
codex config set show_explanations true

🎨 高级技巧

1. 使用管道操作

bash
# 将生成的代码直接写入文件
codex generate "create utility functions" --lang python > utils.py

# 与其他工具组合使用
codex generate "create bash script" --lang bash | sh

2. 批量处理

bash
# 处理多个文件
for file in *.py; do
    codex explain --file "$file" > "${file%.py}_explanation.md"
done

3. 交互模式

bash
# 启动交互模式
codex interactive

# 在交互模式中,您可以:
# > generate "create function"
# > complete last output
# > explain result
# > exit

🔍 调试和问题解决

查看详细输出

bash
# 使用 --verbose 选项查看详细信息
codex generate "create function" --verbose --lang python

检查配置

bash
# 查看当前所有配置
codex config list

# 重置到默认配置
codex config reset

查看帮助

bash
# 查看命令帮助
codex generate --help
codex complete --help

# 查看所有可用命令
codex --help

📈 进阶学习

现在您已经掌握了 Codex CLI 的基础使用,可以继续学习:

  1. 命令参考手册 - 完整的命令和选项参考
  2. 使用教程 - 深入的使用示例和场景

✅ 快速检验

完成以下任务,检验您的学习成果:

  • [ ] 生成一个计算阶乘的函数
  • [ ] 为该函数生成测试用例
  • [ ] 解释生成的代码
  • [ ] 设置您的默认编程语言
  • [ ] 尝试使用管道将代码保存到文件

💬 获得帮助

如果在学习过程中遇到问题:


🎉 恭喜完成快速入门! 您现在已经具备了使用 Codex CLI 的基础知识,可以开始高效的 AI 辅助编程之旅了!

接下来推荐学习 命令参考手册 来掌握更多高级功能。