Documentation
¶
Overview ¶
Package codex provides the built-in Driver implementation for Codex.
Construct a configured driver with Driver and pass it to adaptor.New:
agent := adaptor.New(codex.Driver(codex.Config{
Model: "gpt-5.4",
}))
Driver snapshots its configuration without performing environment I/O. Configuration validation and transport availability checks occur when the agent runs or is inspected. The appserver subpackage contains the typed Codex app-server transport used when that transport is selected.
Index ¶
Constants ¶
const DriverType = "codex"
DriverType is the stable descriptor type for the built-in Codex driver.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type CommonConfig ¶
type CommonConfig = driver.CommonConfig
CommonConfig carries the provider-independent CLI and process defaults embedded by Config: command, cwd, env, instructions, prompt templates, workspace strategy/runtime, timeouts, and extra args.
type Config ¶
type Config struct {
CommonConfig
// Model selects the Codex model. Empty uses the driver's default.
Model string
// ReasoningEffort overrides the model reasoning effort.
ReasoningEffort ReasoningEffort
// FastMode requests Codex's fast service tier defaults.
FastMode bool
}
Config configures the Codex driver.
CommonConfig controls process, profile, and workspace defaults. Model, ReasoningEffort, and FastMode select Codex model and service-tier settings.
type ReasoningEffort ¶
type ReasoningEffort string
ReasoningEffort is the Codex reasoning effort value ("low", "medium", "high", or "xhigh"). The empty value leaves the Codex default in place.
Source Files
Directories