API Reference CodexWrapper v#0.4.0

Copy Markdown View Source

Modules

Elixir wrapper for the Codex CLI.

Behaviour for CLI commands.

Apply command -- apply an agent diff as git apply.

Session lifecycle commands -- archive, unarchive, and delete a saved session.

Authentication commands -- login, logout, status.

Shell completion script generation.

Doctor command -- diagnose the local Codex install, config, auth, and runtime health.

Feature flag management commands.

MCP (Model Context Protocol) server management commands.

Start Codex as an MCP server over stdio.

Sandbox command -- run a command inside the Codex sandbox.

Version command -- parse codex --version output.

Shared client configuration for the Codex CLI.

Exec command -- the primary interface for non-interactive prompts.

ExecResume command -- resume an existing session non-interactively.

Interactive helpers for conversational use in IEx.

A single event from codex's --json NDJSON output.

Result from a completed exec command.

Retry policy with exponential backoff for exec execution.

Review command -- code review with git integration.

How one-shot codex subprocesses are executed.

Leak-free runner backed by forcola.

Default runner: a /bin/sh Port with stdin redirected from /dev/null (Codex CLI hangs if stdin is inherited from the parent), wrapped in a Task for timeout enforcement.

Multi-turn session management.

GenServer wrapper for long-running multi-turn sessions.

:telemetry events emitted by CodexWrapper.

Mix Tasks

Compare every flag the builders emit against the installed codex CLI.