高级配置
高级配置
当你需要更精细地控制提供商、策略和集成时,请使用这些选项。如需快速入门,请参阅配置基础。
如需了解项目指导、可复用能力、自定义斜杠命令、子代理工作流和集成的背景信息,请参阅自定义。有关配置键,请参阅配置参考。
配置方案
配置方案可让你保存具名配置层,并通过
CLI 在它们之间切换。传入 --profile profile-name 时,Codex 会加载
~/.codex/config.toml,然后叠加 ~/.codex/profile-name.config.toml。
配置方案名称可以包含字母、数字、连字符和下划线。
为每个配置方案创建单独的 TOML 文件。在配置方案文件中使用顶层配置键;
不要将它们嵌套在 [profiles.profile-name] 下。
# ~/.codex/deep-review.config.toml
model = "gpt-5.5"
model_reasoning_effort = "xhigh"
approval_policy = "on-request"
model_catalog_json = "/Users/me/.codex/model-catalogs/deep-review.json"codex --profile deep-review
codex exec --profile deep-review "review this change"由于配置方案文件位于基础用户配置之上、项目和 CLI 配置之下,
因此只需包含与基础配置不同的值。
配置方案文件也可以覆盖 model_catalog_json;当两个文件都设置了该值时,Codex 会使用
配置方案中的值。
在 Codex 0.134.0 及更高版本中,--profile 不再从
config.toml 读取 [profiles.profile-name],并且不再支持顶层
profile = "profile-name" 选择器。请将旧版配置方案设置移至
~/.codex/profile-name.config.toml,然后从
config.toml 中移除对应的 [profiles.profile-name] 表和
profile = "profile-name" 选择器。
通过 CLI 进行单次覆盖
除了编辑 ~/.codex/config.toml,你还可以通过 CLI 覆盖单次运行的配置:
- 如果有专用标志,请优先使用(例如
--model)。 - 需要覆盖任意键时,请使用
-c/--config。
示例:
# Dedicated flag
codex --model gpt-5.6-terra
# Generic key/value override (value is TOML, not JSON)
codex --config model='"gpt-5.6-terra"'
codex --config sandbox_workspace_write.network_access=true
codex --config 'shell_environment_policy.include_only=["PATH","HOME"]'注意:
- 键可以使用点号表示法设置嵌套值(例如
mcp_servers.context7.enabled=false)。 --config值会按 TOML 解析。如有疑问,请为值加引号,以免 shell 按空格将其拆分。- 如果值无法解析为 TOML,Codex 会将其视为字符串。
配置和状态位置
Codex 将本地状态存储在 CODEX_HOME 下(默认为 ~/.codex)。
你可能会在其中看到以下常见文件:
config.toml(你的本地配置)auth.json(如果使用基于文件的凭据存储)或操作系统的钥匙串/密钥环history.jsonl(如果启用了历史记录持久化)- 其他每用户状态,例如日志和缓存
有关身份验证的详细信息(包括凭据存储模式),请参阅身份验证。有关完整的配置键列表,请参阅配置参考。
有关签入仓库或系统路径的共享默认设置、规则和技能,请参阅团队配置。
如果只需让内置 OpenAI 提供商指向 LLM 代理、路由器或启用了数据驻留的项目,请在 config.toml 中设置 openai_base_url,而不是定义新的提供商。这样无需单独添加 model_providers.<id> 条目,即可更改内置 openai 提供商的基础 URL。
openai_base_url = "https://us.api.openai.com/v1"项目配置文件(.codex/config.toml)
除用户配置外,Codex 还会读取仓库内 .codex/config.toml 文件中的项目级覆盖设置。Codex 会从项目根目录遍历到当前工作目录,并加载找到的每个 .codex/config.toml。如果多个文件定义了同一个键,则以最接近当前工作目录的文件为准。
出于安全考虑,Codex 仅在项目受信任时加载项目级配置文件。如果项目不受信任,Codex 会忽略项目的 .codex/ 层,包括 .codex/config.toml、项目本地钩子和项目本地规则。用户层和系统层彼此独立,仍会正常加载。
项目配置中的相对路径(例如 model_instructions_file)会相对于包含 config.toml 的 .codex/ 文件夹解析。
项目配置文件无法覆盖会重定向凭据、更改宿主应用请求元数据、
更改提供商身份验证、选择配置方案或运行机器本地通知/遥测命令的设置。
Codex 会忽略项目本地 .codex/config.toml 中的以下键,并在发现它们时输出启动
警告:openai_base_url、chatgpt_base_url、
apps_mcp_product_sku、model_provider、model_providers、notify、
profile、profiles、experimental_realtime_ws_base_url 和 otel。请在用户级
~/.codex/config.toml 中设置提供商、通知和遥测键;使用 --profile profile-name
和 ~/.codex/profile-name.config.toml 选择配置方案。
钩子
Codex 还可以从 hooks.json 文件或与活动配置层相邻的
config.toml 文件内的内联 [hooks] 表加载生命周期钩子。
实际使用中,最有用的四个位置是:
~/.codex/hooks.json~/.codex/config.toml<repo>/.codex/hooks.json<repo>/.codex/config.toml
仅当项目的 .codex/ 层受信任时,才会加载项目本地钩子。
用户级钩子不受项目信任状态影响。
内联 TOML 钩子使用与 hooks.json 相同的事件结构:
[[hooks.PreToolUse]]
matcher = "^Bash$"
[[hooks.PreToolUse.hooks]]
type = "command"
command = '/usr/bin/python3 "$(git rev-parse --show-toplevel)/.codex/hooks/pre_tool_use_policy.py"'
timeout = 30
statusMessage = "Checking Bash command"如果单个配置层同时包含 hooks.json 和内联 [hooks],Codex 会同时加载
两者并发出警告。每个配置层最好只使用一种表示形式。
有关当前事件列表、输入字段、输出行为和限制,请参阅 钩子。
代理角色([agents] 中的 config.toml)
有关子代理角色配置(config.toml 中的 [agents]),请参阅子代理。
项目根目录检测
Codex 会从工作目录开始向上遍历,直到到达项目根目录,以发现项目配置(例如 .codex/ 层和 AGENTS.md)。
默认情况下,Codex 将包含 .git 的目录视为项目根目录。要自定义此行为,请在 config.toml 中设置 project_root_markers:
# Treat a directory as the project root when it contains any of these markers.
project_root_markers = [".git", ".hg", ".sl"]将 project_root_markers = [] 设为跳过搜索父目录,并将当前工作目录视为项目根目录。
自定义模型提供商
模型提供商定义 Codex 如何连接模型(基础 URL、传输 API、身份验证和可选 HTTP 标头)。自定义提供商不能复用以下保留的内置提供商 ID:openai、ollama 和 lmstudio。
定义其他提供商,并让 model_provider 指向它们:
model = "gpt-5.6-terra"
model_provider = "proxy"
[model_providers.proxy]
name = "OpenAI using LLM proxy"
base_url = "http://proxy.example.com"
env_key = "OPENAI_API_KEY"
[model_providers.local_ollama]
name = "Ollama"
base_url = "http://localhost:11434/v1"
[model_providers.mistral]
name = "Mistral"
base_url = "https://api.mistral.ai/v1"
env_key = "MISTRAL_API_KEY"如果自定义提供商支持独立的网页搜索端点,请在其提供商配置中声明 该能力:
[model_providers.proxy]
name = "OpenAI using LLM proxy"
base_url = "https://proxy.example.com/v1"
env_key = "OPENAI_API_KEY"
supports_standalone_web_search = true对于自定义提供商,该设置默认为 false。独立网页搜索仍在
开发中,且默认关闭。将提供商能力设为 true
并不会启用它:提供商必须支持兼容端点,
且所选模型和运行时必须支持独立搜索。已配置的
web_search 模式和
托管搜索限制仍然适用。
按需添加请求标头:
[model_providers.example]
http_headers = { "X-Example-Header" = "example-value" }
env_http_headers = { "X-Example-Features" = "EXAMPLE_FEATURES" }当提供商需要 Codex 从外部凭据辅助程序获取 bearer token 时,请使用基于命令的身份验证:
[model_providers.proxy]
name = "OpenAI using LLM proxy"
base_url = "https://proxy.example.com/v1"
wire_api = "responses"
[model_providers.proxy.auth]
command = "/usr/local/bin/fetch-codex-token"
args = ["--audience", "codex"]
timeout_ms = 5000
refresh_interval_ms = 300000身份验证命令不会接收 stdin,且必须将 token 输出到 stdout。Codex 会去除两端空白,将空 token 视为错误,并在 refresh_interval_ms 时主动刷新;将 refresh_interval_ms = 0 设为仅在身份验证重试后刷新。不要将 [model_providers.<id>.auth] 与 env_key、experimental_bearer_token 或 requires_openai_auth 组合使用。
Amazon Bedrock 提供商
Codex 内置了 amazon-bedrock 模型提供商。直接将其设为
model_provider;与自定义提供商不同,此内置提供商仅支持
嵌套的 AWS 配置方案和区域覆盖设置。
model_provider = "amazon-bedrock"
model = "<bedrock-model-id>"
[model_providers.amazon-bedrock.aws]
profile = "default"
region = "eu-central-1"如果省略 profile,Codex 会使用标准 AWS 凭据链。请将
region 设为应处理请求的受支持 Bedrock 区域。
有关完整设置流程、身份验证选项、支持的模型和功能 可用性,请参阅通过 Amazon Bedrock 使用 ChatGPT Work 和 Codex。
OSS 模式(本地提供商)
传入 --oss 后,Codex 可以使用 Ollama 或 LM
Studio 等本地“开源”提供商运行。使用
--local-provider 为单次运行选择一个提供商,或将 oss_provider 设为默认值。如果两者均未设置,
交互式 CLI 会提示你进行选择;codex exec 会报错退出。
# Default local provider used with `--oss`
oss_provider = "ollama" # or "lmstudio"Azure 提供商和按提供商调优
[model_providers.azure]
name = "Azure"
base_url = "https://YOUR_PROJECT_NAME.openai.azure.com/openai"
env_key = "AZURE_OPENAI_API_KEY"
query_params = { api-version = "2025-04-01-preview" }
wire_api = "responses"
request_max_retries = 4
stream_max_retries = 10
stream_idle_timeout_ms = 300000要更改内置 OpenAI 提供商的基础 URL,请使用 openai_base_url;不要创建 [model_providers.openai],因为内置提供商 ID 无法覆盖。
使用数据驻留的 API 组织
启用了数据驻留的项目可以创建模型提供商,以使用正确的前缀更新 base_url。对于启用了数据驻留的 ChatGPT 工作区,不需要自定义提供商;当你使用 ChatGPT 登录时,Codex 会遵循工作区的数据驻留设置。
model_provider = "openaidr"
[model_providers.openaidr]
name = "OpenAI Data Residency"
base_url = "https://us.api.openai.com/v1" # Replace 'us' with domain prefix模型推理、详细程度和限制
model_reasoning_summary = "none" # Disable summaries
model_verbosity = "low" # Shorten responses
model_supports_reasoning_summaries = true # Force reasoning
model_context_window = 128000 # Context window sizemodel_verbosity 仅适用于使用 Responses API 的提供商。Chat Completions 提供商会忽略该设置。
审批策略和沙箱模式
选择审批严格程度(影响 Codex 何时暂停)和沙箱级别(影响文件/网络访问)。
有关编辑 config.toml 时应注意的操作细节,请参阅常见沙箱与审批组合、可写根目录中的受保护路径和网络访问。
有关可同时配置文件系统和网络访问的测试版权限配置方案,请参阅权限。
你还可以使用精细化审批策略(approval_policy = { granular = { ... } }),允许或自动拒绝各类提示。当你希望某些情况采用常规交互式审批,但希望其他情况(例如 request_permissions 或技能脚本提示)自动以失败关闭时,这很有用。
设置 approvals_reviewer = "auto_review",可将符合条件的交互式审批
请求交由自动审查。这会更改审查方,但不会改变沙箱
边界。
使用 [auto_review].policy 设置本地审查方策略说明。托管的
guardian_policy_config 优先级更高。
approval_policy = "untrusted" # Other options: on-request, never, or { granular = { ... } }
approvals_reviewer = "user" # Or "auto_review" for automatic review
sandbox_mode = "workspace-write"
allow_login_shell = false # Optional hardening: disallow login shells for shell tools
# Example granular approval policy:
# approval_policy = { granular = {
# sandbox_approval = true,
# rules = true,
# mcp_elicitations = true,
# request_permissions = false,
# skill_approval = false
# } }
[sandbox_workspace_write]
exclude_tmpdir_env_var = false # Allow $TMPDIR
exclude_slash_tmp = false # Allow /tmp
writable_roots = ["/Users/YOU/.pyenv/shims"]
network_access = false # Opt in to outbound network
[auto_review]
policy = """
Use your organization's automatic review policy.
"""具名权限配置方案
有关内置配置方案、自定义配置方案语法以及完整的文件系统和 网络配置模型,请参阅权限。
完全禁用沙箱(仅当你的环境已隔离进程时使用):
sandbox_mode = "danger-full-access"Shell 环境策略
shell_environment_policy 控制 Codex 将哪些环境变量传递给
生成的命令。使用 inherit = "none" 从空环境开始,或使用
inherit = "core" 继承经过精简的变量集。添加显式值和基于键的
过滤器,避免向生成的命令传递不必要的密钥。
[shell_environment_policy]
inherit = "core"
set = { MY_FLAG = "1" }
ignore_default_excludes = false
[shell_environment_policy.filters]
"AWS_*" = "exclude"
"AZURE_*" = "exclude"过滤模式不区分大小写,并支持 * 和 ?。使用 "exclude"
移除匹配的变量。当任何模式使用 "include" 时,Codex 只保留
与 include 模式匹配的变量。include 不会恢复已被排除的变量。
过滤器键会在配置层之间以不区分大小写的方式合并。
ignore_default_excludes 默认为 true,因此 Codex 不会自动
移除名称中包含 KEY、SECRET 或 TOKEN 的变量。将其设为 false,
即可在运行显式过滤器之前应用这些自动排除规则。
Codex 会依次应用自动排除规则、自定义排除规则、来自
set 的值,最后应用 include 模式允许列表。由于 set 在
排除规则之后运行,因此它可以恢复被排除的变量。include 模式允许列表
仍可能移除这个已恢复的值。
旧版 exclude 和 include_only 数组仍受支持,以兼容现有
配置。不要在同一个配置层中将其中任一数组与
[shell_environment_policy.filters] 组合使用;Codex
会拒绝这种组合。
MCP 服务器
有关配置详情,请参阅专门的 MCP 文档。
可观测性和遥测
启用 OpenTelemetry (OTel) 日志导出,以跟踪 Codex 运行(API 请求、SSE/事件、提示、工具审批/结果)。默认禁用;通过 [otel] 选择启用:
[otel]
environment = "staging" # defaults to "dev"
exporter = "none" # set to otlp-http or otlp-grpc to send events
log_user_prompt = false # redact user prompts unless explicitly enabled选择导出器:
[otel]
exporter = { otlp-http = {
endpoint = "https://otel.example.com/v1/logs",
protocol = "binary",
headers = { "x-otlp-api-key" = "${OTLP_TOKEN}" }
}}[otel]
exporter = { otlp-grpc = {
endpoint = "https://otel.example.com:4317",
headers = { "x-otlp-meta" = "abc123" }
}}如果为 exporter = "none",Codex 会记录事件但不会发送任何内容。导出器会进行异步批处理,并在关闭时刷新。事件元数据包括服务名称、CLI 版本、环境标签、对话 ID、模型、沙箱/审批设置和各事件的字段(请参阅配置参考)。
发出的内容
Codex 会为运行和工具使用发出结构化日志事件。代表性的事件类型包括:
codex.conversation_starts(模型、推理设置、沙箱/审批策略)codex.api_request(尝试次数、状态/成功与否、持续时间和错误详情)codex.sse_event(流事件种类、成功/失败、持续时间,以及response.completed上的 token 计数)codex.websocket_request和codex.websocket_event(请求持续时间,以及每条消息的种类/成功与否/错误)codex.user_prompt(长度;除非明确启用,否则内容会被隐去)codex.tool_decision(批准/拒绝,以及决策来自配置还是用户)codex.tool_result(持续时间、成功与否、输出片段)
发出的 OTel 指标
启用 OTel 指标管道后,Codex 会针对 API、流和工具活动发出计数器和持续时间直方图。
以下每项指标还包含默认元数据标签:auth_mode、originator、session_source、model 和 app.version。
| 指标 | 类型 | 字段 | 说明 |
|---|---|---|---|
codex.api_request |
计数器 | status, success |
按 HTTP 状态和成功/失败统计的 API 请求数。 |
codex.api_request.duration_ms |
直方图 | status, success |
API 请求持续时间(毫秒)。 |
codex.sse_event |
计数器 | kind, success |
按事件种类和成功/失败统计的 SSE 事件数。 |
codex.sse_event.duration_ms |
直方图 | kind, success |
SSE 事件处理持续时间(毫秒)。 |
codex.websocket.request |
计数器 | success |
按成功/失败统计的 WebSocket 请求数。 |
codex.websocket.request.duration_ms |
直方图 | success |
WebSocket 请求持续时间(毫秒)。 |
codex.websocket.event |
计数器 | kind, success |
按类型和成功/失败统计的 WebSocket 消息/事件数。 |
codex.websocket.event.duration_ms |
直方图 | kind, success |
WebSocket 消息/事件处理持续时间(毫秒)。 |
codex.tool.call |
计数器 | tool, success |
按工具名称和成功/失败统计的工具调用次数。 |
codex.tool.call.duration_ms |
直方图 | tool, success |
按工具名称和结果统计的工具执行持续时间(毫秒)。 |
有关遥测的更多安全和隐私指导,请参阅安全性。
指标
默认情况下,Codex 会定期向 OpenAI 发送少量匿名使用情况和运行状况数据。这有助于发现 Codex 无法正常工作的情况,并了解正在使用哪些功能和配置选项,以便 Codex 团队专注于最重要的事项。这些指标不包含任何个人身份信息 (PII)。指标收集独立于 OTel 日志/跟踪导出。
如果想在一台机器上完全禁用 ChatGPT 桌面应用、Codex CLI 和 IDE 扩展的指标收集,请在配置中设置分析标志:
[analytics]
enabled = false每项指标都包含自身字段以及以下默认上下文字段。
默认上下文字段(适用于每个事件/指标)
auth_mode:swic|api|unknown。model:所用模型的名称。app.version:Codex 版本。
指标目录
每项指标都包含必需字段以及上述默认上下文字段。以下指标名称省略了 codex. 前缀。
大多数指标名称集中定义在 codex-rs/otel/src/metrics/names.rs 中;此处也包含在该文件之外发出的特定功能指标。
如果某项指标包含 tool 字段,它表示所使用的内部工具(例如 apply_patch 或 shell),且不包含 codex 尝试应用的实际 shell 命令或补丁。
运行时和模型传输
| 指标 | 类型 | 字段 | 说明 |
|---|---|---|---|
api_request |
计数器 | status, success |
按 HTTP 状态和成功/失败统计的 API 请求数。 |
api_request.duration_ms |
直方图 | status, success |
API 请求持续时间(毫秒)。 |
sse_event |
计数器 | kind, success |
按事件种类和成功/失败统计的 SSE 事件数。 |
sse_event.duration_ms |
直方图 | kind, success |
SSE 事件处理持续时间(毫秒)。 |
websocket.request |
计数器 | success |
按成功/失败统计的 WebSocket 请求数。 |
websocket.request.duration_ms |
直方图 | success |
WebSocket 请求持续时间(毫秒)。 |
websocket.event |
计数器 | kind, success |
按类型和成功/失败统计的 WebSocket 消息/事件数。 |
websocket.event.duration_ms |
直方图 | kind, success |
WebSocket 消息/事件处理持续时间(毫秒)。 |
responses_api_overhead.duration_ms |
直方图 | 来自 WebSocket 响应的 Responses API 开销计时。 | |
responses_api_inference_time.duration_ms |
直方图 | 来自 WebSocket 响应的 Responses API 推理计时。 | |
responses_api_engine_iapi_ttft.duration_ms |
直方图 | Responses API 引擎的 IAPI 首 token 时间。 | |
responses_api_engine_service_ttft.duration_ms |
直方图 | Responses API 引擎的服务首 token 时间。 | |
responses_api_engine_iapi_tbt.duration_ms |
直方图 | Responses API 引擎的 IAPI token 间隔时间。 | |
responses_api_engine_service_tbt.duration_ms |
直方图 | Responses API 引擎的服务 token 间隔时间。 | |
transport.fallback_to_http |
计数器 | from_wire_api |
WebSocket 回退至 HTTP 的次数。 |
remote_models.fetch_update.duration_ms |
直方图 | 获取远程模型定义所需的时间。 | |
remote_models.load_cache.duration_ms |
直方图 | 加载远程模型缓存所需的时间。 | |
startup_prewarm.duration_ms |
直方图 | status |
按结果统计的启动预热持续时间。 |
startup_prewarm.age_at_first_turn_ms |
直方图 | status |
首个实际轮次解析启动预热时的预热时长。 |
cloud_requirements.fetch.duration_ms |
直方图 | 获取工作区托管云端要求的持续时间。 | |
cloud_requirements.fetch_attempt |
计数器 | 见注释 | 获取工作区托管云端要求的尝试次数。 |
cloud_requirements.fetch_final |
计数器 | 见注释 | 获取工作区托管云端要求的最终结果。 |
cloud_requirements.load |
计数器 | trigger, outcome |
加载工作区托管云端要求的结果。 |
cloud_requirements.fetch_attempt 指标包含 trigger、attempt、outcome 和 status_code 字段。cloud_requirements.fetch_final 指标包含 trigger、outcome、reason、attempt_count 和 status_code 字段。
轮次和工具活动
| 指标 | 类型 | 字段 | 说明 |
|---|---|---|---|
turn.e2e_duration_ms |
直方图 | 完整轮次的端到端时间。 | |
turn.ttft.duration_ms |
直方图 | 轮次的首 token 时间。 | |
turn.ttfm.duration_ms |
直方图 | 轮次首个模型输出项的时间。 | |
turn.network_proxy |
计数器 | active, tmp_mem_enabled |
托管网络代理在该轮次是否处于活动状态。 |
turn.memory |
计数器 | read_allowed, feature_enabled, config_use_memories, has_citations |
每轮次的记忆读取可用性和记忆引用使用情况。 |
turn.tool.call |
直方图 | tmp_mem_enabled |
轮次中的工具调用次数。 |
turn.token_usage |
直方图 | token_type, tmp_mem_enabled |
按 token 类型(total、input、cached_input、output 或 reasoning_output)统计的每轮次 token 使用量。 |
tool.call |
计数器 | tool, success |
按工具名称和成功/失败统计的工具调用次数。 |
tool.call.duration_ms |
直方图 | tool, success |
按工具名称和结果统计的工具执行持续时间(毫秒)。 |
tool.unified_exec |
计数器 | tty |
按 TTY 模式统计的统一 exec 工具调用。 |
approval.requested |
计数器 | tool, approved |
工具审批请求结果(approved、approved_with_amendment、approved_for_session、denied、abort)。 |
mcp.call |
计数器 | 见注释 | MCP 工具调用结果。 |
mcp.call.duration_ms |
直方图 | 见注释 | MCP 工具调用持续时间。 |
mcp.tools.list.duration_ms |
直方图 | cache |
MCP 工具列表持续时间,包括缓存命中/未命中状态。 |
mcp.tools.fetch_uncached.duration_ms |
直方图 | 未命中缓存的 MCP 工具获取持续时间。 | |
mcp.tools.cache_write.duration_ms |
直方图 | Codex Apps MCP 工具缓存写入持续时间。 | |
hooks.run |
计数器 | hook_name, source, status |
按钩子名称、来源和状态统计的钩子运行次数。 |
hooks.run.duration_ms |
直方图 | hook_name, source, status |
钩子运行持续时间(毫秒)。 |
mcp.call 和 mcp.call.duration_ms 指标包含 status;常规工具调用发出内容还包含 tool,并在可用时包含 connector_id 和 connector_name。被阻止的 Codex Apps MCP 调用可能会发出仅包含 status 的 mcp.call。
线程、任务和功能
| 指标 | 类型 | 字段 | 说明 |
|---|---|---|---|
feature.state |
计数器 | feature, value |
与默认值不同的功能值(每个非默认值发出一行)。 |
status_line |
计数器 | 会话以已配置的状态行启动。 | |
model_warning |
计数器 | 发送给模型的警告。 | |
thread.started |
计数器 | is_git |
新建线程,并标记工作目录是否位于 Git 仓库中。 |
conversation.turn.count |
计数器 | 每个线程的用户/助手轮次数,在该线程结束时记录。 | |
thread.fork |
计数器 | source |
通过派生现有线程创建的新线程。 |
thread.rename |
计数器 | 线程已重命名。 | |
thread.side |
计数器 | source |
创建的侧边对话。 |
thread.skills.enabled_total |
直方图 | 为新线程启用的技能数量。 | |
thread.skills.kept_total |
直方图 | 渲染提示后保留的已启用技能数量。 | |
thread.skills.truncated |
直方图 | 技能渲染是否截断已启用技能列表(1 或 0)。 |
|
task.compact |
计数器 | type |
按类型(remote 或 local)统计的压缩次数,包括手动和自动压缩。 |
task.review |
计数器 | 触发的审查次数。 | |
task.undo |
计数器 | 触发的撤销操作次数。 | |
task.user_shell |
计数器 | 用户 shell 操作次数(例如 TUI 中的 !)。 |
|
shell_snapshot |
计数器 | 见注释 | shell 快照是否成功生成。 |
shell_snapshot.duration_ms |
直方图 | success |
生成 shell 快照所需的时间。 |
skill.injected |
计数器 | status, skill |
按技能统计的技能注入结果。 |
plugins.startup_sync |
计数器 | transport, status |
精选插件启动同步尝试次数。 |
plugins.startup_sync.final |
计数器 | transport, status |
精选插件启动同步的最终结果。 |
multi_agent.spawn |
计数器 | role |
按角色统计的代理生成次数。 |
multi_agent.resume |
计数器 | 代理恢复次数。 | |
multi_agent.nickname_pool_reset |
计数器 | 代理昵称池重置次数。 |
shell_snapshot 指标包含 success,并在失败时包含 failure_reason。
记忆和本地状态
| 指标 | 类型 | 字段 | 说明 |
|---|---|---|---|
memory.phase1 |
计数器 | status |
按状态统计的记忆阶段 1 作业数。 |
memory.phase1.e2e_ms |
直方图 | 记忆阶段 1 的端到端持续时间。 | |
memory.phase1.output |
计数器 | 写入的记忆阶段 1 输出数量。 | |
memory.phase1.token_usage |
直方图 | token_type |
按 token 类型统计的记忆阶段 1 token 使用量。 |
memory.phase2 |
计数器 | status |
按状态统计的记忆阶段 2 作业数。 |
memory.phase2.e2e_ms |
直方图 | 记忆阶段 2 的端到端持续时间。 | |
memory.phase2.input |
计数器 | 记忆阶段 2 输入数量。 | |
memory.phase2.token_usage |
直方图 | token_type |
按 token 类型统计的记忆阶段 2 token 使用量。 |
memories.usage |
计数器 | kind, tool, success |
按种类、工具和成功/失败统计的记忆使用情况。 |
external_agent_config.detect |
计数器 | 见注释 | 按迁移项类型统计的外部代理配置检测次数。 |
external_agent_config.import |
计数器 | 见注释 | 按迁移项类型统计的外部代理配置导入次数。 |
db.backfill |
计数器 | status |
初始状态数据库回填结果(upserted、failed)。 |
db.backfill.duration_ms |
直方图 | status |
初始状态数据库回填的持续时间。 |
db.error |
计数器 | stage |
状态数据库操作期间的错误。 |
external_agent_config.detect 和 external_agent_config.import 指标包含 migration_type;技能迁移还包含 skills_count。
Windows 沙箱
| 指标 | 类型 | 字段 | 说明 |
|---|---|---|---|
windows_sandbox.setup_success |
计数器 | originator, mode |
Windows 沙箱设置成功次数。 |
windows_sandbox.setup_failure |
计数器 | originator, mode |
Windows 沙箱设置失败次数。 |
windows_sandbox.setup_duration_ms |
直方图 | result, originator, mode |
Windows 沙箱设置持续时间。 |
windows_sandbox.elevated_setup_success |
计数器 | 提权 Windows 沙箱设置成功次数。 | |
windows_sandbox.elevated_setup_failure |
计数器 | 见注释 | 提权 Windows 沙箱设置失败次数。 |
windows_sandbox.elevated_setup_canceled |
计数器 | 见注释 | 已取消的提权 Windows 沙箱设置尝试次数。 |
windows_sandbox.elevated_setup_duration_ms |
直方图 | result |
提权 Windows 沙箱设置持续时间。 |
windows_sandbox.elevated_prompt_shown |
计数器 | 显示提权沙箱设置提示的次数。 | |
windows_sandbox.elevated_prompt_accept |
计数器 | 接受提权沙箱设置提示的次数。 | |
windows_sandbox.elevated_prompt_use_legacy |
计数器 | 用户在提权提示中选择旧版沙箱的次数。 | |
windows_sandbox.elevated_prompt_quit |
计数器 | 用户从提权提示中退出的次数。 | |
windows_sandbox.fallback_prompt_shown |
计数器 | 显示回退沙箱提示的次数。 | |
windows_sandbox.fallback_retry_elevated |
计数器 | 用户从回退提示中重试提权设置的次数。 | |
windows_sandbox.fallback_use_legacy |
计数器 | 用户从回退提示中选择旧版沙箱的次数。 | |
windows_sandbox.fallback_prompt_quit |
计数器 | 用户从回退提示中退出的次数。 | |
windows_sandbox.legacy_setup_preflight_failed |
计数器 | 见注释 | 旧版 Windows 沙箱设置预检失败次数。 |
windows_sandbox.setup_elevated_sandbox_command |
计数器 | 调用提权沙箱设置命令的次数。 | |
windows_sandbox.createprocessasuserw_failed |
计数器 | error_code, path_kind, exe, level |
Windows CreateProcessAsUserW 失败次数。 |
当 Windows 设置失败详情可用时,权限提升设置失败指标包括 code 和 message;从共享设置路径发出时,还可能包括 originator。从共享设置路径发出时,windows_sandbox.legacy_setup_preflight_failed 指标包括 originator,但后备提示预检失败可能不包含任何字段。
反馈控制
默认情况下,本地客户端允许用户从 /feedback 发送反馈。要在一台计算机上停用 ChatGPT 桌面应用、Codex CLI 和 IDE 扩展的反馈收集,请更新配置:
[feedback]
enabled = false停用后,/feedback 会显示停用消息,并且 Codex 会拒绝反馈提交。
隐藏或显示推理事件
如果想减少冗杂的“推理”输出(例如 CI 日志中的输出),可以将其隐藏:
hide_agent_reasoning = true如果想在模型发出原始推理内容时将其显示出来:
show_raw_agent_reasoning = true仅在原始推理适合你的工作流时才启用它。某些模型/提供商(如 gpt-oss)不会发出原始推理;在这种情况下,此设置不会产生可见效果。
通知
每当 Codex 发出支持的事件(目前仅限 agent-turn-complete)时,使用 notify 触发外部程序。这适用于桌面通知、聊天 Webhook、CI 更新,或内置 TUI 通知未涵盖的任何旁路提醒。
notify = ["python3", "/path/to/notify.py"]下面是响应 agent-turn-complete 的 notify.py 示例(已截断):
#!/usr/bin/env python3
import json, subprocess, sys
def main() -> int:
notification = json.loads(sys.argv[1])
if notification.get("type") != "agent-turn-complete":
return 0
title = f"Codex: {notification.get('last-assistant-message', 'Turn Complete!')}"
message = " ".join(notification.get("input-messages", []))
subprocess.check_output([
"terminal-notifier",
"-title", title,
"-message", message,
"-group", "codex-" + notification.get("thread-id", ""),
"-activate", "com.googlecode.iterm2",
])
return 0
if __name__ == "__main__":
sys.exit(main())该脚本接收单个 JSON 参数。常见字段包括:
type(目前为agent-turn-complete)thread-id(会话标识符)turn-id(轮次标识符)cwd(工作目录)input-messages(促成该轮次的用户消息)last-assistant-message(最后一条助手消息的文本)
将脚本放在磁盘上的某个位置,并让 notify 指向它。
notify 与 tui.notifications
notify运行外部程序(适用于 Webhook、桌面通知程序和 CI 钩子)。tui.notifications内置于 TUI,并且可以选择按事件类型筛选(例如agent-turn-complete和approval-requested)。tui.notification_method控制 TUI 发出终端通知的方式(auto、osc9或bel)。tui.notification_condition控制是否仅在终端为unfocused或always时触发 TUI 通知。
在 auto 模式下,Codex 优先使用 OSC 9 通知(某些终端会将这种终端转义序列解释为桌面通知),否则回退到 BEL(\x07)。
有关确切的键,请参阅配置参考。
历史记录持久化
默认情况下,Codex 将本地会话转录记录保存在 CODEX_HOME 下(例如 ~/.codex/history.jsonl)。要停用本地历史记录持久化:
[history]
persistence = "none"要限制历史记录文件的大小,请设置 history.max_bytes。当文件超过此限制时,Codex 会丢弃最早的条目并压缩文件,同时保留最新记录。
[history]
max_bytes = 104857600 # 100 MiB可点击的引用
如果你使用的终端/编辑器集成支持此功能,Codex 可以将文件引用呈现为可点击的链接。配置 file_opener,以选择 Codex 使用的 URI 方案:
file_opener = "vscode" # or cursor, windsurf, vscode-insiders, none示例:可以将 /home/user/project/main.py:42 这样的引用改写为可点击的 vscode://file/...:42 链接。
项目指令发现
Codex 会读取 AGENTS.md(及相关文件),并在会话的第一轮中加入有限数量的项目指南。以下两个选项控制其工作方式:
project_doc_max_bytes:从每个AGENTS.md文件中读取多少内容project_doc_fallback_filenames:在某一级目录中缺少AGENTS.md时要尝试的其他文件名
有关详细演练,请参阅使用 AGENTS.md 配置自定义指令。
桌面应用
本节中的选项仅适用于 ChatGPT 桌面应用。
添加自定义文件处理程序
在用户级 ~/.codex/config.toml 中的
desktop.custom_file_handlers 下添加条目,即可使用 ChatGPT 桌面应用默认不支持的编辑器或内部启动程序
打开文件。每个条目都会向应用的打开方式菜单添加一个
编辑器目标。当 command 是现有的绝对路径,或可从应用的 PATH 中解析时,
应用会列出该目标。
以下示例展示了将文件传递给处理程序的三种方式:
# Append the opened path directly after the command.
[desktop.custom_file_handlers.vscodium]
label = "VSCodium"
icon = "/Users/you/.codex/icons/vscodium.png"
command = "codium"
# Place fixed arguments before the opened path.
[desktop.custom_file_handlers.textedit]
label = "TextEdit"
icon = "/Users/you/.codex/icons/textedit.png"
command = "/usr/bin/open"
args = ["-a", "TextEdit"]
# Append one JSON argument with the path and editor context.
[desktop.custom_file_handlers.company_editor]
label = "Company Editor"
icon = "/opt/company/editor/icon.png"
command = "/opt/company/bin/editor"
input = "json_argument"保存 config.toml,然后重启 ChatGPT 桌面应用。
处理程序 ID 是 TOML 表头的最后一段。它必须包含
1–64 个字符,以 ASCII 字母或数字开头,其余字符只能是
ASCII 字母、数字、句点、下划线或连字符。应用会为该 ID 添加
custom: 前缀;例如,company_editor 会变为
custom:company_editor。包含句点的 ID 应使用引号括起来,以免 TOML
将其解释为嵌套表。例如:
[desktop.custom_file_handlers."company.editor"]
label = "Company Editor"
icon = "/opt/company/editor/icon.png"
command = "/opt/company/bin/editor"每个处理程序支持以下字段:
| 字段 | 必需 | 说明 |
|---|---|---|
label |
是 | 应用中显示的名称。 |
icon |
是 | 内置应用图标(如 apps/vscode.png)、base64 data:image/... URL、file: URI 或本地图片绝对路径。不支持的来源将使用默认 VS Code 图标。 |
command |
是 | 用于检测和启动的可执行文件路径或命令名称。 |
args |
否 | 插入到 command 与文件输入之间的字符串数组。默认为 []。 |
input |
否 | 应用发送文件输入的方式:path、json_argument 或 json_stdin。默认为 path。 |
supports_ssh |
否 | 是否为 SSH 工作区中的文件提供该处理程序。默认为 false。当处理程序需要远程主机和路径详情时,请使用 json_stdin。 |
input 值控制 args 之后的内容:
path将路径追加为最后一个命令参数。json_argument追加一个包含target、path、appPath和location的 JSON 对象。location值是一个包含从 1 开始计数的line和column值的对象,或者为null。json_stdin将 JSON 对象写入标准输入,而不是添加为 参数。它还包括hostConfig、remoteWorkspaceRoot和remotePath;当这些字段不适用时,其值为null。
例如,当用户打开特定源代码位置时,company_editor 可以接收以下参数:
{
"target": "custom:company_editor",
"path": "/repo/src/index.ts",
"appPath": null,
"location": { "line": 12, "column": 3 }
}选择自定义处理程序作为首选编辑器后,其选择将以与选择内置编辑器相同的 方式持久保存,包括按项目保存的偏好设置。
TUI 选项
运行不带子命令的 codex 会启动交互式终端 UI(TUI)。Codex 在 [tui] 下提供了一些 TUI 专用配置,包括:
tui.notifications:启用/停用通知(或限制为特定类型)tui.notification_method:选择使用auto、osc9或bel发送终端通知tui.notification_condition:选择unfocused或always,以控制何时 触发通知tui.animations:启用/停用 ASCII 动画和微光效果tui.alternate_screen:控制备用屏幕的使用(设为never可保留终端回滚内容)tui.show_tooltips:显示或隐藏欢迎屏幕上的入门工具提示
tui.notification_method 默认为 auto。在 auto 模式下,当终端看起来支持 OSC 9 通知(某些终端会将这种终端转义序列解释为桌面通知)时,Codex 会优先使用它;否则回退到 BEL(\x07)。
有关完整的键列表,请参阅配置参考。