Codex Router 社区文档 EN GitHub
最后更新

让 AI Agent 安装 Codex Router（AGENTS.md）

让 AI Agent 安装 Codex Router 是最省事的方式。仓库带有一份机器可读的 AGENTS.md 流程，引导式安装器负责供应商选择、凭据引导与验证。本页给你要粘贴的指令原文，说明 Agent 会做什么，并列出保护你的密钥与现有配置的安全边界。

粘贴到 Codex 任务

Install the router from this public repository:
https://github.com/duolahypercho/codex-router

Follow AGENTS.md. Preserve my existing Codex models, profiles, settings, and
ChatGPT login. Use only the provider authentication I choose, safely migrate
only recognized older versions, run the Codex doctor, and leave the final app
restart to me. Never ask me to paste a token or API key into chat.

如果已有可用认证，Agent 可以完成除最后一次 App 重启之外的所有步骤。API Key 只通过隐藏的本地终端提示输入——Agent 绝不会经对话中转。

Agent 会做什么

按照 AGENTS.md，Agent 按顺序执行以下步骤：

  1. 读取主机平台，检查 Codex、Git、Node.js 22.19+ 与 uv 或 Python 3.10+。只允许只读检查；未经许可不会安装包管理器或运行时。
  2. 使用稳定检出目录——macOS/Linux 用 ~/.local/share/codex-router，Windows 用 %LOCALAPPDATA%\codex-router——绝不用临时克隆，因为服务会保存检出目录的绝对路径。
  3. 确定你要的供应商 ID（例如 deepseek、kimi-oauth、grok-api、anthropic-api）；已有凭据时用 configured。
  4. Kimi OAuth 复用有效 kimi login 会话，或只在交互终端中运行官方 CLI。API 供应商则在 PTY 中执行 provider-key PROVIDER set，让隐藏提示直接接收值。
  5. 执行只读旧版检测，仅对仓库可识别的旧安装传 --migrate-known。绝不会自动迁移、停止、删除或替换未知路由器。
  6. 运行安装器（macOS/Linux：./install.sh --target codex --auto --providers IDS --migrate-known；Windows 用对应的 PowerShell 形式）。
  7. 运行 ./bin/model-router codex doctor。核心配置、配置隐私、目录、调用方能力、内部密钥、服务、路由器健康与所选凭据必须为 OK。
  8. 某托管层失败时运行 doctor --fix（仅对已识别的旧安装加 --migrate-known）；仍失败则创建 support bundle。
  9. 不会终止 Codex。由你完全退出、重新打开、新建任务并选择新模型。

Agent 遵循的安全规则

  • 绝不让你在对话、命令行参数、日志、环境片段或受版本控制的文件中粘贴 OAuth token 或 API Key。
  • 保留推理设置、配置档案、项目、信任设置、MCP 配置、功能与 ChatGPT 认证。
  • 绝不杀死 4100–4103 端口（或 Grok OAuth 转发器 4108 端口）上的未知进程。
  • 把生成的 /_codex-router/.../v1 配置路径视为敏感的本地认证，绝不把完整托管 URL 粘贴进对话或公开 issue。
  • 安装任务中不重启、不退出 Codex App。

之后检查什么

Agent 报告成功后：

  1. 完全退出 Codex，重新打开并新建任务。
  2. 打开模型选择器，确认路由模型出现。
  3. 需要脱敏健康摘要时可运行 ./bin/model-router codex status（或托盘状态视图）。
  4. 有异常时打开故障排查或运行 doctor --fix。

Agent 驱动流程与仓库 AGENTS.md 记录的完全一致，Agent 说的每一步都可以对照该文件核验。