Modules§
- config_
toml - Schema-heavy configuration TOML types used by Codex.
- loader
- permissions_
toml - profile_
toml - schema
- test_
support - Test-only helpers exposed for cross-crate integration tests.
- types
- Types used to define loaded and effective Codex configuration values.
Structs§
- Absolute
Path Buf - A path that is guaranteed to be absolute and normalized (though it is not guaranteed to be canonicalized or exist on the filesystem).
- AppRequirement
Toml - AppTool
Requirement Toml - AppTools
Requirements Toml - Apps
Requirements Toml - Bundled
Skills Config - Cloud
Config Bundle - Cloud
Config Bundle Layers - Cloud config bundle converted into semantic layer buckets.
- Cloud
Config Bundle Load Error - Cloud
Config Bundle Loader - Cloud
Config Fragment - Config fragment delivered by the cloud config bundle.
- Cloud
Config Fragment Source - Cloud
Config Toml Bundle - Cloud
Requirements Fragment - Cloud
Requirements Toml Bundle - Computer
UseRequirements Toml - Config
Edits Builder - Config
Error - Config
Layer - A materialized configuration layer and its provenance.
- Config
Layer Entry - Config
Layer Metadata - Identity and version information for a configuration layer.
- Config
Layer Stack - Config
Load Error - Config
Load Options - User-facing config loading behavior that is not part of the config document.
- Config
Requirements - Normalized version of
ConfigRequirementsTomlafter deserialization and normalization. - Config
Requirements Toml - Base config deserialized from system
requirements.tomlor MDM. - Config
Requirements With Sources - Constrained
- Constrained
With Source - Feature
Requirements Toml - Filesystem
Constraints - Filesystem
Deny Read Pattern - Hook
Events Toml - Hook
State Toml - Hooks
File - Hooks
Toml - Loader
Overrides - LoaderOverrides overrides managed configuration inputs (primarily for tests).
- Managed
Hooks Requirements Toml - Marketplace
Allowed Source Toml - Raw marketplace source rule whose active fields are interpreted after requirements composition.
- Marketplace
Config Update - Marketplace
Requirements Toml - Matcher
Group - McpServer
Command Matcher - McpServer
Config - McpServerO
Auth Config - OAuth client settings used when Codex launches an MCP OAuth flow.
- McpServer
Tool Config - Per-tool approval settings for a single MCP server tool.
- Models
Requirements Toml - Network
Constraints - Normalized network constraints derived from requirements TOML.
- Network
Domain Permissions Toml - Network
Requirements Toml - Network
Unix Socket Permissions Toml - NewThread
Model Defaults Toml - Noop
Thread Config Loader - Loader used when no external thread config source is configured.
- Plugin
Requirements Toml - Profile
V2Name - Validated plain profile-v2 name used to select
$CODEX_HOME/<name>.config.toml. - Profile
V2Name Parse Error - RawMcp
Server Config - Raw MCP config shape used for deserialization and supported-field JSON Schema generation.
- Remote
Sandbox Config Toml - Remote
Thread Config Loader - gRPC-backed
ThreadConfigLoaderimplementation. - Requirements
Exec Policy - Requirements
Exec Policy Pattern Token Toml - TOML-friendly representation of a pattern token.
- Requirements
Exec Policy Prefix Rule Toml - A TOML representation of the
prefix_rule(...)Starlark builtin. - Requirements
Exec Policy Toml - TOML representation of
[rules]withinrequirements.toml. - Requirements
Layer Entry - Session
Thread Config - Config values owned by the service that starts or manages the session.
- Skill
Config - Skills
Config - Sourced
- Value paired with the requirement source it came from, for better error messages.
- Static
Thread Config Loader - Loader backed by a static set of typed thread config sources.
- Text
Position - Text
Range - Text range in 1-based line/column coordinates.
- Thread
Config Context - Context available to implementations when loading thread-scoped config.
- Thread
Config Load Error - User
Thread Config - Config values owned by the authenticated user.
- Windows
Requirements Toml
Enums§
- AppTool
Approval - Cloud
Config Bundle Load Error Code - Cloud
Config Layer Error - Config
Layer Source - Provenance for one layer in the effective Codex configuration.
- Config
Layer Stack Ordering - Constraint
Error - Hook
Handler Config - Marketplace
Allowed Source Kind - McpServer
Auth - Authentication flow Codex attempts after resolving an HTTP MCP server’s configured bearer token and authorization headers, which always take precedence. ChatGPT authentication falls back to stored OAuth credentials when its session provider is unavailable; both modes ultimately fall back to an unauthenticated connection.
- McpServer
Disabled Reason - Human-readable reason a configured MCP server was disabled after requirements were applied.
- McpServer
EnvVar - McpServer
Identity - McpServer
Requirement - A requirement for one named MCP server.
- McpServer
Transport Config - McpServer
Value Matcher - String matching operations available to managed MCP server matchers.
- Network
Domain Permission Toml - Network
Unix Socket Permission Toml - Plugin
Config Edit - Remove
Marketplace Config Outcome - Requirement
Source - Requirements
Exec Policy Decision Toml - Requirements
Exec Policy Parse Error - Residency
Requirement - Sandbox
Mode Requirement - Currently,
external-sandboxis not supported in config.toml, but it is supported through programmatic use. - Shell
Environment Policy Filter Representation - The mutually exclusive shell-environment filter representations.
- Thread
Config Load Error Code - Stable category for failures returned while loading thread config.
- Thread
Config Source - A typed config payload paired with the authority that produced it.
- Toml
Value - Representation of a TOML value.
- WebSearch
Mode Requirement
Constants§
- CONFIG_
TOML_ FILE - DEFAULT_
MCP_ SERVER_ ENVIRONMENT_ ID - Effective MCP environment id when config omits
environment_id.
Traits§
- Thread
Config Loader - Loads typed config sources for a new thread.
Functions§
- apply_
user_ plugin_ config_ edits - build_
cli_ overrides_ layer - clear_
user_ plugin - cloud_
config_ layers_ from_ fragments - compose_
requirements - config_
error_ from_ ignored_ toml_ fields - config_
error_ from_ toml - config_
error_ from_ typed_ toml - default_
project_ root_ markers - first_
layer_ config_ error - first_
layer_ config_ error_ from_ entries - format_
config_ error - format_
config_ error_ with_ source - format_
config_ layer_ source - host_
name - Returns a process-cached canonical hostname, falling back to the normalized kernel hostname. The first call on Unix may perform blocking DNS resolution.
- io_
error_ from_ config_ error - load_
global_ mcp_ servers - merge_
toml_ values - Merge config
overlayintobase, givingoverlayprecedence. - project_
root_ markers_ from_ config - Reads
project_root_markersfrom a mergedconfig.tomltoml::Value. - record_
user_ marketplace - remove_
user_ marketplace - remove_
user_ marketplace_ config - sandbox_
mode_ requirement_ for_ permission_ profile - set_
user_ plugin_ enabled - shell_
environment_ filter_ entry - Looks up a shell-environment filter pattern while ignoring case.
- validate_
shell_ environment_ policy_ filter_ config - Validates only the shell-environment filter representation in a raw config overlay.
- version_
for_ toml