# 法典顾问 ## 概述当您需要对计划进行外部验证、代码审查或遇到难题时，可以使用 OpenAI 的 Codex CLI 作为第二意见顾问。该技能使用非交互模式（“codex exec”）进行脚本/自动使用。 ## 何时使用 * 开始工作前审查实施计划 * 复杂或安全敏感变更的代码审查 * 需要进行重大权衡的架构决策 * 调试卡住超过 30 分钟的问题 * 寻求解决方案的替代方法 * 验证关于不熟悉的代码库的假设 ## 先决条件 * OpenAI API 密钥或 ChatGPT Plus/Pro/Business 帐户 * 安装了 Codex CLI ### 安装 # 通过 npm npm install -g @openai/codex # 或者通过自制程序酿造安装--木桶法典 ### 身份验证 # 选项 1：API 密钥（CI 中的非交互模式需要）导出 OPENAI_API_KEY="您的密钥" # 选项 2：CI 环境的 Codex 特定密钥导出 CODEX_API_KEY="您的密钥" # 选项 3：交互式登录（一次性设置）法典--登录 ## 型号选择为您的任务选择正确的型号：型号|最适合 |使用时间 ---|---|--- `gpt-5.2` |通用推理 |计划审查、架构问题、非编码任务的默认设置 `gpt-5.2-codex` |现实世界的软件工程|代码审查、调试、特定于编码的任务 `gpt-5.1-codex-max` |扩展的多步骤工作流程 |长时间运行的任务（>10 分钟）、大型迁移、复杂的重构 `gpt-5.1-codex-mini` |注重预算的项目|当成本很重要时进行简单的审查 **推荐：** * 一般问题从“gpt-5.2”开始 * 当任务专门涉及代码时，使用“gpt-5.2-codex” * 使用 `gpt-5.1-codex-max` 来执行涉及许多文件或复杂的多步骤工作的任务 ## 推理努力水平始终使用“xhigh”推理进行彻底分析：水平|使用案例 ---|--- `xhigh` | **默认** \- 深度分析、安全审查、架构决策 `高` |当延迟很重要时进行复杂的分析 `中` |对简单任务的快速响应 `低`/`无` |不推荐用于顾问用例 ## 非交互模式所有命令都使用“codex exec”进行非交互式执行。这对于脚本化使用和管道传输至关重要。 ### 关键标志旗帜|目的 ---|--- `--json` |用于机器解析的输出 JSON 行 `-o <路径>` |将最终消息保存到文件 `-C <路径>` |设置工作目录（对当前代码库使用“-C .”） `--全自动` |启用文件修改（谨慎使用） `--沙箱只读` |只读沙箱（默认，最安全） `--sandbox 工作区-写入` |仅允许写入工作区 ### 输出处理 # 用于解析的 JSON 输出 codex exec -m gpt-5.2 -c model_reasoning_effort="xhigh" \ --json "您的提示" 2>/dev/null # 保存到文件 codex exec -m gpt-5.2 -c model_reasoning_effort="xhigh" \ -o output.txt“您的提示” # 管道输入和捕获输出 git 差异 | codex exec -m gpt-5.2-codex -c model_reasoning_effort="xhigh" \ “查看此差异”> review.txt 2>/dev/null ## 命令参考 ### 计划审查获取有关实施计划的反馈： codex exec -m gpt-5.2 -c model_reasoning_effort="xhigh" \ “审查此实施计划。确定潜在问题、遗漏的边缘情况、安全问题或更好的方法： <在此处粘贴计划>” 对于涉及当前代码库的计划： codex exec -m gpt-5.2 -c model_reasoning_effort="xhigh" -C 。 \ “在此代码库的背景下审查此实施计划。确定潜在问题、与现有模式的冲突或更好的方法： <在此处粘贴计划>” ### 代码审查检查代码更改是否存在错误、安全问题和改进： # 查看分阶段的更改 git diff --staged | git diff --staged | git diff --staged | git diff --staged | codex exec -m gpt-5.2-codex -c model_reasoning_effort="xhigh" \ “在提交之前检查这些更改。检查： - 错误或逻辑错误 - 安全漏洞 - 性能问题 - 缺少错误处理” # 查看特定差异 git 差异 | codex exec -m gpt-5.2-codex -c model_reasoning_effort="xhigh" \ “查看此差异是否存在错误、安全问题和改进” # 使用代码库上下文进行审查 codex exec -m gpt-5.2-codex -c model_reasoning_effort="xhigh" -C 。 \ “查看 src/auth/login.ts 中的错误、安全漏洞并提出改进建议” ### 解决困难问题当遇到困难的问题时： codex exec -m gpt-5.2-codex -c model_reasoning_effort="xhigh" -C 。 \ “我陷入了这个问题：<描述> 我尝试过的： 1.<尝试1> 2.<尝试2> 我看到的错误/行为：<详细信息> 建议解决方案或调试方法。” ### 架构决策获取有关设计权衡的意见： codex exec -m gpt-5.2 -c model_reasoning_effort="xhigh" -C 。 \ “我需要在的这些方法之间做出决定：选项 A：<描述> 选项 B：<描述> 考虑到这个代码库，哪种方法更好，为什么？考虑可维护性、性能以及与现有模式的一致性。” ### 替代方法当你想要一个新的视角时： codex exec -m gpt-5.2 -c model_reasoning_effort="xhigh" -C 。 \ “这是我目前解决<问题>的方法：<描述> 有哪些替代方法可以解决这个问题？我缺少什么？” ## 工作流程示例 ### 实施前审查 codex exec -m gpt-5.2 -c model_reasoning_effort="xhigh" -C 。 \ “查看用户身份验证系统的实施计划： 1. Express路由中添加JWT中间件 2. 创建 /auth/login 和 /auth/register 端点 3. 在Redis中存储刷新令牌 4.添加auth端点速率限制找出缺失的部分、安全问题或更好的方法。” ### 提交前审查 git diff --staged | git diff --staged | git diff --staged | git diff --staged | codex exec -m gpt-5.2-codex -c model_reasoning_effort="xhigh" \ “查看 PR 的这些更改。检查： - 错误或逻辑错误 - 安全漏洞 - 性能问题 - 缺少错误处理 - 测试覆盖率差距提供具体的逐行反馈。” ### 长时间运行的迁移对于复杂的多文件重构，请使用“gpt-5.1-codex-max”： codex exec -m gpt-5.1-codex-max -c model_reasoning_effort="xhigh" -C 。 \ “帮助我将此代码库从 Express 迁移到 Fastify。检查当前结构并创建详细的迁移计划。识别所有需要更改和潜在重大更改的文件。” ## 持续集成/自动化对于 CI 环境，请使用“CODEX_API_KEY”： # CI环境下 CODEX_API_KEY=${{ Secrets.CODEX_API_KEY }} \ codex exec -m gpt-5.2-codex -c model_reasoning_effort="xhigh" \ --json“查看此代码”> review.json ### GitHub 操作示例 - 名称：使用 Codex 进行代码审查环境： CODEX_API_KEY：${{secrets.CODEX_API_KEY}} 运行：| git diff origin/main...HEAD | git diff origin/main...HEAD | git diff origin/main...HEAD |法典执行\ -m gpt-5.2-codex \ -c model_reasoning_effort="xhigh" \ -o 评论.txt \ “查看此 PR 差异是否存在错误和安全问题” ## 最佳实践 ### 何时使用 Codex Advisor * 影响多个系统的复杂变化 * 安全敏感代码（身份验证、加密、输入验证） * 性能关键部分 * 不熟悉的代码库或语言 * 当您被困超过 30 分钟时 ### 何时不使用 * 简单、明显的更改（拼写错误、格式） * 修复了一些小错误并提供了明确的解决方案 * 当您需要快速进行低风险变更时 * 已建立模式的重复性任务 ### 获得更好结果的技巧 1. **提供上下文**：包括相关文件路径、错误消息以及您尝试过的内容 2. **具体**：提出有针对性的问题，而不是“回顾一切” 3. **使用`-C .`**：让 Codex 查看您的代码库以获取上下文感知建议 4. **选择正确的模型**：`gpt-5.2` 用于通用，`gpt-5.2-codex` 用于代码，`gpt-5.1-codex-max` 用于复杂 5. **验证建议**：始终根据您的代码库验证 Codex 的建议 ## 安全考虑 * Codex将代码发送到OpenAI的服务器进行分析 * 在共享专有代码之前查看您组织的政策 * 避免在代码示例中发送敏感凭证、API 密钥或 PII * 使用具有适当速率限制的 API 密钥进行使用情况监控 ## 故障排除 ###“stdin 不是终端” 当管道数据时，始终使用“codex exec”： # 错误 - 交互模式不支持管道输入 git 差异 | codex -m gpt-5.2“查看此...” # 正确 - 使用 exec 进行非交互式执行 git 差异 | codex exec -m gpt-5.2“查看此...” ###“未找到命令” # 检查安装情况哪个法典 # 如果需要重新安装 npm install -g @openai/codex ### 身份验证错误 # 以交互方式重新验证法典--登录 # 或者设置API密钥导出 OPENAI_API_KEY="您的密钥" 导出 CODEX_API_KEY="your-key" # 对于 CI ### 速率限制对于大量使用，请使用具有适当层限制的 API 密钥，而不是 ChatGPT 身份验证。 ### 无输出/空响应确保 stderr 与 stdout 分开处理： # 正确捕获输出 codex exec -m gpt-5.2 -c model_reasoning_effort="xhigh" \ “你的提示”2>/dev/null>output.txt # 或者使用 -o 标志 codex exec -m gpt-5.2 -c model_reasoning_effort="xhigh" \ -o output.txt“您的提示”

法典顾问

包含技能