Struct CodexHarness 

pub struct CodexHarness { /* private fields */ }

OpenAI Codex CLI as a Harness.

Implementations

impl CodexHarness

pub fn new() -> Self

Drives codex from PATH.

pub fn custom(config: CodexHarnessConfig) -> Self

Drives a binary the host names.

Trait Implementations

impl Clone for CodexHarness

fn clone(&self) -> CodexHarness

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CodexHarness

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CodexHarness

fn default() -> Self

Returns the “default value” for a type.

impl Harness for CodexHarness

fn info(&self) -> Info

Who this harness is — identity and presentation, for the picker.

fn features(&self) -> Features

What this harness supports, so a consumer adapts to it declaratively instead of branching on Info::id.

fn list_models(&self) -> Result<Vec<ModelChoice>, Error>

Enumerate the models this harness can run, live. The default returns the static list declared in Info (capabilities().models), so existing adapters need no change.

fn readiness(&self) -> Readiness

Probe availability / version / auth. May shell out; callers should treat it as blocking and run it off the UI thread.

fn start( &self, request: RunRequest, on_event: RunCallback, ) -> Result<RunHandle, Error>

Start a run, streaming events through on_event. Returns a handle immediately; work continues on background threads.

fn credential(&self) -> CredentialSpec

The credential this harness needs.

fn login(&self, on_event: InstallCallback) -> Result<(), Error>

Trigger the harness’s own interactive sign-in (its CLI’s OAuth), streaming progress as InstallEvents. The flow opens the user’s browser; this blocks until the login process exits, then Done { ok } reports success. This is the agent authenticating itself — distinct from installing it, which the host’s user does. Default: unsupported, for harnesses the host authenticates by key.

fn model_management(&self) -> Option<ModelManagement>

Whether this harness can install/list/delete its own models locally, and if so the endpoint metadata a host UI can surface (see ModelManagement). None (the default) means model management isn’t supported — a host hides the “Manage models” surface. Only the openai-compatible Ollama adapter returns Some today.

fn list_installed_models(&self) -> Result<Vec<InstalledModel>, Error>

Installed local models with their on-disk size + details, for a manager UI (distinct from list_models, the picker’s name-only set). Default: unsupported — override alongside model_management. Blocking (hits the local server); run it off the UI thread.

fn pull_model( &self, _model: &str, _cancel: &AtomicBool, _on_progress: PullProgressCallback<'_>, ) -> Result<(), Error>

Download (install) a model, streaming progress to on_progress. cancel is polled during the download; flipping it aborts the pull. Blocking until the download finishes (or fails / is cancelled); run it off the UI thread. Default: unsupported.

fn delete_model(&self, _model: &str) -> Result<(), Error>

Remove an installed local model. Removing one that’s already absent succeeds (the requested end state). Default: unsupported.

fn run( &self, request: RunRequest, ) -> Result<(RunHandle, Receiver<RunEvent>), Error>

Convenience over run for callers that want to pull events off a channel instead of supplying a push callback. Forwards each RunEvent into an mpsc channel and hands the receiver back alongside the run handle, so the caller can simply for event in rx { … } rather than re-write the Arc::new(move |ev| tx.send(ev)) plumbing at every call site.