Struct CodexAgentConfig 

pub struct CodexAgentConfig {

    pub command: PathBuf,
    pub args: Vec<String>,
    pub cwd: PathBuf,
    pub auth_method_id: String,
    pub authenticate: bool,
    pub client_name: String,
    pub client_version: String,
    pub rpc_deadline: Duration,
    pub max_line_bytes: usize,
    pub max_output_queue: usize,
    pub auto_allow_permissions: bool,
    pub advertise_fs: bool,
    pub raw_dump_path: Option<PathBuf>,
}

How to launch the ACP server process for Codex.

Fields

command: PathBuf

Command to run (default: discover codex-acp, else npx).

args: Vec<String>

Args after command (default: empty for codex-acp, or ["--yes","@agentclientprotocol/codex-acp"] for npx).

cwd: PathBuf

Working directory for the process and default session cwd.

auth_method_id: String

Auth method id for ACP authenticate when authenticate is true.

codex-acp advertises ChatGPT login and API-key methods; default leaves auth to existing codex login / OPENAI_API_KEY / CODEX_API_KEY.

authenticate: bool

When true, send authenticate after initialize (may open a login flow).

client_name: String

Client name reported in initialize.

client_version: String

Client version reported in initialize.

rpc_deadline: Duration

Handshake / RPC deadline.

max_line_bytes: usize

Max bytes per NDJSON line (fail-closed).

max_output_queue: usize

Bounded output queue for dialect bytes (session/update lines).

auto_allow_permissions: bool

Auto-answer session/request_permission with allow-once.

advertise_fs: bool

When true, advertise client fs read/write capabilities.

raw_dump_path: Option<PathBuf>

Optional path to append raw NDJSON lines (test diagnostics only).

Implementations

impl CodexAgentConfig

pub fn for_project(cwd: impl Into<PathBuf>) -> Self

Config for a project directory.

pub fn with_raw_dump(self, path: impl Into<PathBuf>) -> Self

Attach a raw NDJSON dump path.

pub fn with_codex_path_env_hint(self) -> Self

Point at a specific Codex binary via CODEX_PATH for the adapter.

The ACP adapter reads CODEX_PATH from the process environment; this only records intent for callers (env is set by the host before spawn).

pub fn with_global_codex_acp(self) -> Self

Prefer a globally installed codex-acp binary when present.

pub fn with_auto_allow_permissions(self) -> Self

Force unattended permission auto-allow on the ACP client side.

Only for trusted test sandboxes / unattended qualification.

Trait Implementations

impl Clone for CodexAgentConfig

fn clone(&self) -> CodexAgentConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodexAgentConfig

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

Formats the value using the given formatter.

impl Default for CodexAgentConfig

fn default() -> Self

Returns the “default value” for a type.