API Reference codex_ex v#0.1.0

Copy Markdown View Source

Modules

Public entrypoint for the Codex app-server client.

Shares long-lived Codex app-server clients across callers with the same launcher config.

Helpers for protocol-native app-server notifications and server requests.

In-process mock of the Codex app-server protocol for testing.

Public thread service object for the app-server client.

Stable app-server thread goal value.

Typed app-level representation of thread items.

The one item type whose text streams in deltas, so the runtime needs it typed. attrs still carries the complete protocol payload — phase and status are conveniences read from it, not a replacement for it.

Effective Codex settings observed for a loaded thread.

Stable typed snapshot of an app-server thread.

Stable typed token-usage model for turn streams.

Stable typed snapshot of an app-server turn.

Typed collector for a single app-server turn.

Shallow key normalisation for maps entering from external sources.

Mix Tasks

Generates Elixir protocol structs and codecs from the committed Codex app-server JSON Schema snapshot.

Runs codex app-server generate-json-schema --experimental and snapshots the exported schema bundle into a tracked repo directory.

Regenerates the Codex app-server protocol modules into a temporary directory and fails if the committed generated files have drifted from the current schema snapshot.