|
| 1 | +--- |
| 2 | +title: Codex |
| 3 | +tags: |
| 4 | + - Agent |
| 5 | + - CLI |
| 6 | +--- |
| 7 | + |
| 8 | +# Codex |
| 9 | + |
| 10 | +- [openai/codex](httpss://github.com/openai/codex) |
| 11 | + |
| 12 | +```bash |
| 13 | +npm i -g @openai/codex |
| 14 | +brew install codex |
| 15 | + |
| 16 | +codex --version |
| 17 | + |
| 18 | +# OPENAI_API_KEY 第一次会写入 auth.json ,之后需要修改 auth.json |
| 19 | +OPENAI_BASE_URL=https://api.openai.com/v1 OPENAI_API_KEY=sk-proj-1234567890 codex --model deepseek-v3.2-exp |
| 20 | + |
| 21 | +# 使用自定义 provider,环境变量定义 env_key |
| 22 | +MY_PROVIDER_KEY=xyz codex |
| 23 | +# 使用内置 OPENAI provider,环境变量定义 base_url |
| 24 | +OPENAI_BASE_URL=xyz codex |
| 25 | + |
| 26 | +# ~/.codex/log/codex-tui.log |
| 27 | +RUST_LOG=debug codex |
| 28 | +# 会包含 request |
| 29 | +RUST_LOG=trace codex |
| 30 | +``` |
| 31 | + |
| 32 | +## 配置 {#config} |
| 33 | + |
| 34 | +Codex 支持多种设置配置值的机制: |
| 35 | + |
| 36 | +- 特定于配置的命令行标志,例如 `--model o3`(最高优先级)。 |
| 37 | +- 通用 `-c`/`--config` 标志,接受 `key=value` 对,例如 `--config model="o3"`。 |
| 38 | +- CODEX_HOME=~/.codex |
| 39 | +- $CODEX_HOME/config.toml |
| 40 | +- 参考 |
| 41 | + - https://github.com/openai/codex/issues/2760 |
| 42 | + |
| 43 | +```toml |
| 44 | +model=gpt-5-codex # 模型 |
| 45 | +model_provider=openai |
| 46 | +# 批准策略 |
| 47 | +# untrusted, on-failure, on-request, never |
| 48 | +approval_policy=untrusted |
| 49 | +# 沙箱策略 |
| 50 | +# read-only, workspace-write, danger-full-access |
| 51 | +sandbox_mode=read-only |
| 52 | + |
| 53 | +# 启用的 profile |
| 54 | +profiles=o3 |
| 55 | + |
| 56 | +# MCP 服务器 |
| 57 | +mcp_servers=mcp-server |
| 58 | + |
| 59 | +# 传递给子进程的环境变量 |
| 60 | +shell_environment_policy=inherit=all |
| 61 | + |
| 62 | +# 内置 openai provider |
| 63 | +[model_providers.openai] |
| 64 | +name = "OpenAI" |
| 65 | +# OPENAI_BASE_URL |
| 66 | +base_url = "https://api.openai.com/v1" |
| 67 | +env_key = "OPENAI_API_KEY" |
| 68 | +# 使用 v1/chat/completions 还是 v1/responses |
| 69 | +# chat, responses |
| 70 | +wire_api = "chat" |
| 71 | + |
| 72 | +# 请求配置 |
| 73 | +query_params = {} |
| 74 | +http_headers = { } |
| 75 | + |
| 76 | +env_http_headers = { "OpenAI-Organization" = "OPENAI_ORGANIZATION", "OpenAI-Project" = "OPENAI_PROJECT" } |
| 77 | + |
| 78 | +request_max_retries = 4 |
| 79 | +stream_max_retries = 5 |
| 80 | +# 等待 stream 响应的时间 |
| 81 | +stream_idle_timeout_ms = 300000 |
| 82 | + |
| 83 | +[model_providers.ollama] |
| 84 | +name = "Ollama" |
| 85 | +base_url = "http://localhost:11434/v1" |
| 86 | + |
| 87 | +[model_providers.azure] |
| 88 | +name = "Azure" |
| 89 | +base_url = "https://YOUR_PROJECT_NAME.openai.azure.com/openai" |
| 90 | +env_key = "AZURE_OPENAI_API_KEY" |
| 91 | +query_params = { api-version = "2025-04-01-preview" } |
| 92 | +wire_api = "responses" |
| 93 | +``` |
| 94 | + |
| 95 | +| 变量 | 描述 | |
| 96 | +| --------------------- | ----------------------------------------------------------- | |
| 97 | +| `OPENAI_API_KEY` | 您的 OpenAI API 密钥。 | |
| 98 | +| `CODEX_HOME` | 用于日志、配置和其他数据的目录。默认为 `~/.codex`。 | |
| 99 | +| `CODEX_API_KEY` | API 密钥,仅在 `codex exec` 中支持。 | |
| 100 | +| `RUST_LOG` | 配置日志记录行为 (例如, `codex_core=info,codex_tui=info`)。 | |
| 101 | +| `<PROVIDER>_API_KEY` | 特定提供程序的 API 密钥 (例如, `MISTRAL_API_KEY`)。 | |
| 102 | +| `<PROVIDER>_BASE_URL` | 自定义提供程序的基础 URL。 | |
| 103 | +| `RUST_LOG` | 配置日志记录行为 (例如, `codex_core=info,codex_tui=info`)。 | |
| 104 | + |
| 105 | +## auth.json |
| 106 | + |
| 107 | +- OPENAI_API_KEY |
| 108 | +- tokens |
| 109 | + - id_token |
| 110 | + - email |
| 111 | + - chatgpt_plan_type |
| 112 | + - Free, Plus, Pro, Team, Business, Enterprise, Edu |
| 113 | + - raw_jwt |
| 114 | + - access_token |
| 115 | + - refresh_token |
| 116 | + - account_id |
| 117 | +- last_refresh |
0 commit comments