# CodexWrapper v0.5.3 - Table of Contents

> Elixir wrapper for the Codex CLI

## Pages

- [CodexWrapperEx](readme.md)
- [Changelog](changelog.md)
- [LICENSE](license.md)

## Modules

- Running codex
  - [CodexWrapper](CodexWrapper.md): Elixir wrapper for the Codex CLI.
  - [CodexWrapper.Exec](CodexWrapper.Exec.md): Exec command -- the primary interface for non-interactive prompts.
  - [CodexWrapper.ExecFork](CodexWrapper.ExecFork.md): ExecFork command -- branch an existing session into a new one, non-interactively.
  - [CodexWrapper.ExecResume](CodexWrapper.ExecResume.md): ExecResume command -- resume an existing session non-interactively.
  - [CodexWrapper.IEx](CodexWrapper.IEx.md): Interactive helpers for conversational use in IEx.
  - [CodexWrapper.Review](CodexWrapper.Review.md): Review command -- code review with git integration.
  - [CodexWrapper.Session](CodexWrapper.Session.md): Multi-turn session management.
  - [CodexWrapper.SessionServer](CodexWrapper.SessionServer.md): GenServer wrapper for long-running multi-turn sessions.

- Config, results, support
  - [CodexWrapper.Config](CodexWrapper.Config.md): Shared client configuration for the Codex CLI.
  - [CodexWrapper.JsonLineEvent](CodexWrapper.JsonLineEvent.md): A single event from codex's `--json` NDJSON output.
  - [CodexWrapper.Result](CodexWrapper.Result.md): Result from a completed exec command.
  - [CodexWrapper.Retry](CodexWrapper.Retry.md): Retry policy with exponential backoff for exec execution.
  - [CodexWrapper.Telemetry](CodexWrapper.Telemetry.md): `:telemetry` events emitted by CodexWrapper.
  - [CodexWrapper.UnsupportedError](CodexWrapper.UnsupportedError.md): Raised when the installed Codex CLI lacks a capability a lazy stream needs.

- Subprocess execution
  - [CodexWrapper.Runner](CodexWrapper.Runner.md): How one-shot `codex` subprocesses are executed.
  - [CodexWrapper.Runner.Forcola](CodexWrapper.Runner.Forcola.md): Leak-free runner backed by [forcola](https://hex.pm/packages/forcola).
  - [CodexWrapper.Runner.Port](CodexWrapper.Runner.Port.md): 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.

- Command surface
  - [CodexWrapper.Command](CodexWrapper.Command.md): Behaviour for CLI commands.
  - [CodexWrapper.Commands.Apply](CodexWrapper.Commands.Apply.md): Apply command -- apply an agent diff as git apply.
  - [CodexWrapper.Commands.Archive](CodexWrapper.Commands.Archive.md): Session lifecycle commands -- archive, unarchive, and delete a saved session.
  - [CodexWrapper.Commands.Auth](CodexWrapper.Commands.Auth.md): Authentication commands -- login, logout, status.
  - [CodexWrapper.Commands.Completion](CodexWrapper.Commands.Completion.md): Shell completion script generation.
  - [CodexWrapper.Commands.Doctor](CodexWrapper.Commands.Doctor.md): Doctor command -- diagnose the local Codex install, config, auth, and
runtime health.
  - [CodexWrapper.Commands.Features](CodexWrapper.Commands.Features.md): Feature flag management commands.
  - [CodexWrapper.Commands.Mcp](CodexWrapper.Commands.Mcp.md): MCP (Model Context Protocol) server management commands.
  - [CodexWrapper.Commands.McpServer](CodexWrapper.Commands.McpServer.md): Start Codex as an MCP server over stdio.
  - [CodexWrapper.Commands.Sandbox](CodexWrapper.Commands.Sandbox.md): Sandbox command -- run a command inside the Codex sandbox.
  - [CodexWrapper.Commands.Version](CodexWrapper.Commands.Version.md): Version command -- parse `codex --version` output.

## Mix Tasks

- [mix codex.contract](Mix.Tasks.Codex.Contract.md): Compare every flag the builders emit against the installed `codex` CLI.