API Reference oban_codex v#0.1.0

Copy Markdown View Source

Modules

Run Codex CLI work on an Oban queue.

A facade over long-lived agent processes whose turns run as Oban jobs.

One agent as one :gen_statem process, its asynchronous turns run as Oban jobs. Part of the experimental agent layer (see ObanCodex.Agent).

The default Oban worker for agent turns: runs Codex, then routes the outcome back to the owning ObanCodex.Agent.Instance.

The supervision root for the agent lifecycle spike: a Registry (tracking agent_id -> current state) plus a DynamicSupervisor that owns the ObanCodex.Agent.Instance processes.

The adapter between Oban.Plugins.Cron (which schedules at the worker layer) and the agent state machine (which owns turn enqueueing): a scheduled tick delivers a prompt to an agent through the facade, never a Codex job behind the machine's back.

Build a Codex job's string-keyed, JSON-safe Oban args.

A normalized execution error from the Codex wrapper.

Default mapping from Codex execution outcomes to Oban verdicts.

Translate validated ObanCodex options into fresh or resumed Codex commands.

Build deterministic Codex outcomes for worker tests without invoking the CLI.

Define an Oban worker that runs a Codex job.

Mix Tasks

Run Codex from the CLI: mix oban_codex <run|doctor|args>.

Scaffold a runnable SQLite-backed oban_codex setup.