SuperAPI AI 工具集

codex-cli

编程与开发

查看项目

更新于 10-16 09:18

技能介绍

用途

Codex CLI 是一个命令行编码智能体,能够执行开发任务、生成代码、编辑文件并完成各类编码操作。本技能聚焦于其非交互模式:Codex 执行单个任务并返回结果,不进入交互式会话。当用户明确提到 Codex、Codex CLI,或需要以编程方式自动化编码任务时使用。

主要能力

  • 非交互执行:通过 codex exec [OPTIONS] <PROMPT>(短别名 codex e)以单个提示运行 Codex。
  • 模型选择:-m/--model 指定模型,如 gpt-5-codex(面向编码与工具调用优化)、gpt-5(通用推理与世界知识更强);--oss 通过本地 Ollama 使用开源模型。
  • 工作目录:-C/--cd 指定智能体工作目录。
  • 跳过 Git 仓库检查:--skip-git-repo-check,用于非 Git 目录或未受信任目录。
  • 图像附件:-i 附加一张或多张图片用于视觉分析。
  • 沙箱策略:-s 可选 read-only、workspace-write、danger-full-access。
  • 审批策略:-a 可选 untrusted、on-failure、on-request、never。
  • 便捷标志:--full-auto 等价于 -a on-failure --sandbox workspace-write;--dangerously-bypass-approvals-and-sandbox 跳过所有确认与沙箱(极度危险,仅限外部已沙箱化环境)。
  • 配置管理:-c 覆盖 ~/.codex/config.toml 中的配置值(支持点路径、JSON 解析);-p/--profile 加载配置档案。
  • Web 搜索:--search 启用原生 web_search 工具(默认关闭)。
  • 其他命令:codex apply(应用最新 diff)、codex resume(恢复会话)、codex login/logout(认证)、codex mcp(实验性 MCP 服务器)、codex proto(协议流)、codex completion(补全脚本)、codex debug(调试)。

使用方式

基本命令结构:

codex exec [OPTIONS] <PROMPT>
codex e [OPTIONS] <PROMPT>    # 短别名

不指定子命令时进入交互模式:codex [OPTIONS] [PROMPT]。

常见用法示例:

  • 只读代码分析:codex exec -s read-only "analyze the code quality in src/ and suggest improvements"
  • 自动化重构:codex exec -s workspace-write -a on-failure "refactor all API endpoints to use async/await"
  • 自动批准快速修复:codex exec --full-auto "fix ESLint errors in components/"
  • 指定模型生成代码:codex exec -m gpt-5-codex "create a REST API with authentication using Express.js"
  • 多图分析:codex exec -i wireframe.png -i screenshot.png "compare this wireframe with the current implementation"
  • 指定项目目录:codex exec -C ~/projects/myapp "add unit tests for the UserService class"
  • 研究驱动开发:codex exec --search "implement OAuth2 authentication following current best practices"
  • 本地开源模型:codex exec --oss "document all functions in utils.py"
  • 自定义配置:codex exec -c model="o3" -c 'sandbox_permissions=["disk-full-read-access"]' "task"
  • 非 Git 目录快速查询:codex exec --skip-git-repo-check -s read-only "explain how to configure VS Code keybindings"

配置文件位于 ~/.codex/config.toml,可创建档案、设置默认值,避免重复命令行标志。

适用场景

  • 在脚本或 CI/CD 中自动化任务(如自动格式化、生成文档、生成测试)。
  • 运行一次性命令、与其他工具集成、需要可预测的非交互行为。
  • 需要带可配置安全控制的智能体编码能力。
  • 预提交钩子中检查潜在缺陷或安全问题。

限制与安全提醒

  • 部署到生产前应审查生成的代码。
  • 根据任务选择适当的沙箱与审批设置;分析或审计不熟悉的代码时先用 read-only。
  • 除外部已沙箱化环境(如容器、VM)外,切勿使用 --dangerously-bypass-approvals-and-sandbox。
  • 提示中避免包含凭据和敏感数据。
  • 建议将 --full-auto 作为高效、安全自动化的默认选项。
  • 在非 Git 目录运行可能报错“Not inside a trusted directory and --skip-git-repo-check was not specified”,需使用 --skip-git-repo-check。
  • 模型可用性、具体收费与价格信息暂未提供。