Class CodexCliAdapter

Codex CLI adapter using subprocess transport.

Extends SubprocessCliAdapter which provides:

Retry logic with exponential backoff
Health checks with version compatibility
Capacity tracking
Subprocess spawn with timeout handling

Hierarchy (View Summary)

SubprocessCliAdapter
- CodexCliAdapter

Constructors

constructor

new CodexCliAdapter(options?: BaseAdapterOptions): CodexCliAdapter
Parameters
- Optionaloptions: BaseAdapterOptions
Returns CodexCliAdapter
Overrides SubprocessCliAdapter.constructor
- Defined in packages/nexus-agents/src/cli-adapters/adapters/codex-adapter.ts:52

Properties

`Readonly`name

name: "claude" | "gemini" | "codex" | "opencode" = 'codex'

CLI name

`Protected` `Readonly`parser

parser: ICliResponseParser = ...

`Protected` `Readonly`logger

logger: ILogger

`Protected`capacityTracker

capacityTracker: CapacityTracker | null = null

`Protected`initialized

initialized: boolean = false

`Protected` `Optional`lastHealthCheck

lastHealthCheck?: HealthStatus

`Protected` `Optional`cachedVersion

cachedVersion?: string

`Readonly`transport

transport: CliTransport = 'subprocess'

Transport type

`Protected` `Readonly`transientRetry

transientRetry: TransientRetryConfig = ...

Transient-error retry config. Override in subclass to enable.

Accessors

capabilities

get capabilities(): CliCapabilityProfile
Gets the capability profile for this CLI.

Returns CliCapabilityProfile
Inherited from SubprocessCliAdapter.capabilities
- Defined in packages/nexus-agents/src/cli-adapters/base-adapter.ts:96

Methods

getModelInfo

getModelInfo(): CliModelInfo
Gets Codex model information. Resolves from canonical registry when possible, falls back to legacy lookup.

Returns CliModelInfo
Overrides SubprocessCliAdapter.getModelInfo
- Defined in packages/nexus-agents/src/cli-adapters/adapters/codex-adapter.ts:61

`Protected`getCommand

getCommand(task: CliTask): CommandConfig
Gets CLI command and arguments for execution. Task content is passed as a positional argument (not via stdin).
Parameters
- task: CliTask
Returns CommandConfig
Overrides SubprocessCliAdapter.getCommand
- Defined in packages/nexus-agents/src/cli-adapters/adapters/codex-adapter.ts:80

`Protected`initCapacityTracker

initCapacityTracker(): void
Initializes the capacity tracker. Called by subclasses after name is set.

Returns void
Inherited from SubprocessCliAdapter.initCapacityTracker
- Defined in packages/nexus-agents/src/cli-adapters/base-adapter.ts:89

execute

execute(
task: CliTask,
options?: CliExecutionOptions,
): Promise<Result<CliResponse, CliError>>
Executes a task with error handling and retries.

Timeout priority (highest to lowest):
1. options.timeoutMs - explicit execution option
2. task.timeoutMs - task-level setting
3. getTimeoutForTaskAuto() - computed from task complexity and CLI
Parameters
- task: CliTask
- Optionaloptions: CliExecutionOptions
Returns Promise<Result<CliResponse, CliError>>
Inherited from SubprocessCliAdapter.execute
- Defined in packages/nexus-agents/src/cli-adapters/base-adapter.ts:135

healthCheck

healthCheck(): Promise<HealthStatus>
Performs a health check.

Returns Promise<HealthStatus>
Inherited from SubprocessCliAdapter.healthCheck
- Defined in packages/nexus-agents/src/cli-adapters/base-adapter.ts:200

getVersion

getVersion(): Promise<string>
Gets CLI version.

Returns Promise<string>
Inherited from SubprocessCliAdapter.getVersion
- Defined in packages/nexus-agents/src/cli-adapters/base-adapter.ts:230

getCapacity

getCapacity(): Promise<CapacityStatus>
Gets current capacity status based on tracked usage. Uses usage-based tracking since CLI subprocess execution doesn't expose HTTP rate limit headers.

Returns Promise<CapacityStatus>
See
Issue #456 - Real API rate limit tracking
Inherited from SubprocessCliAdapter.getCapacity
- Defined in packages/nexus-agents/src/cli-adapters/base-adapter.ts:256

`Protected`recordUsage

recordUsage(response: CliResponse): void
Records usage from a response for capacity tracking.
Parameters
- response: CliResponse
Returns void
Inherited from SubprocessCliAdapter.recordUsage
- Defined in packages/nexus-agents/src/cli-adapters/base-adapter.ts:281

`Protected`parseVersion

parseVersion(output: string): string
Parses version from CLI output.
Parameters
- output: string
Returns string
Inherited from SubprocessCliAdapter.parseVersion
- Defined in packages/nexus-agents/src/cli-adapters/base-adapter.ts:290

`Protected`checkVersionCompatibility

checkVersionCompatibility(version: string): VersionStatus
Checks version compatibility.
Parameters
- version: string
Returns VersionStatus
Inherited from SubprocessCliAdapter.checkVersionCompatibility
- Defined in packages/nexus-agents/src/cli-adapters/base-adapter.ts:302

`Protected`getVersionMessage

getVersionMessage(status: VersionStatus, version: string): string | undefined
Gets version status message.
Parameters
- status: VersionStatus
- version: string
Returns string | undefined
Inherited from SubprocessCliAdapter.getVersionMessage
- Defined in packages/nexus-agents/src/cli-adapters/base-adapter.ts:331

`Protected`createError

createError(code: CliErrorCode, message: string, cause?: Error): CliError
Creates a CLI error.
Parameters
- code: CliErrorCode
- message: string
- Optionalcause: Error
Returns CliError
Inherited from SubprocessCliAdapter.createError
- Defined in packages/nexus-agents/src/cli-adapters/base-adapter.ts:349

`Protected`normalizeResponse

normalizeResponse(
    text: string,
    usage?: CliTokenUsage,
    extra?: Partial<CliResponse>,
): CliResponse
Normalizes CLI response to common format.
Parameters
- text: string
- Optionalusage: CliTokenUsage
- Optionalextra: Partial<CliResponse>
Returns CliResponse
Inherited from SubprocessCliAdapter.normalizeResponse
- Defined in packages/nexus-agents/src/cli-adapters/base-adapter.ts:364

`Protected`delay

delay(ms: number): Promise<void>
Delays for the specified milliseconds.
Parameters
- ms: number
Returns Promise<void>
Inherited from SubprocessCliAdapter.delay
- Defined in packages/nexus-agents/src/cli-adapters/base-adapter.ts:379

executeTask

executeTask(
task: CliTask,
options: Required<CliExecutionOptions>,
): Promise<Result<CliResponse, CliError>>
Executes a task via subprocess, with optional transient-error retry. When transientRetry.enabled is true, transient errors (timeout, rate_limit, connection, parse) are retried with exponential backoff (500ms, 1000ms). Parse errors get max 1 retry (#1533); others get 2.
Parameters
- task: CliTask
- options: Required<CliExecutionOptions>
Returns Promise<Result<CliResponse, CliError>>
Inherited from SubprocessCliAdapter.executeTask
- Defined in packages/nexus-agents/src/cli-adapters/subprocess-adapter.ts:255

initialize

initialize(): Promise<void>
Initializes the adapter and capacity tracker.

Returns Promise<void>
Inherited from SubprocessCliAdapter.initialize
- Defined in packages/nexus-agents/src/cli-adapters/subprocess-adapter.ts:599

dispose

dispose(): Promise<void>
Disposes the adapter (no-op for subprocess).

Returns Promise<void>
Inherited from SubprocessCliAdapter.dispose
- Defined in packages/nexus-agents/src/cli-adapters/subprocess-adapter.ts:608

Class CodexCliAdapter

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CodexCliAdapter

Properties

Readonlyname

Protected Readonlyparser

Protected Readonlylogger

ProtectedcapacityTracker

Protectedinitialized

Protected OptionallastHealthCheck

Protected OptionalcachedVersion

Readonlytransport

Protected ReadonlytransientRetry

Accessors

capabilities

Returns CliCapabilityProfile

Methods

getModelInfo

Returns CliModelInfo

ProtectedgetCommand

Parameters

Returns CommandConfig

ProtectedinitCapacityTracker

Returns void

execute

Parameters

Returns Promise<Result<CliResponse, CliError>>

healthCheck

Returns Promise<HealthStatus>

getVersion

Returns Promise<string>

getCapacity

Returns Promise<CapacityStatus>

See

ProtectedrecordUsage

Parameters

Returns void

ProtectedparseVersion

Parameters

Returns string

ProtectedcheckVersionCompatibility

Parameters

Returns VersionStatus

ProtectedgetVersionMessage

Parameters

Returns string | undefined

ProtectedcreateError

Parameters

Returns CliError

ProtectednormalizeResponse

Parameters

Returns CliResponse

Protecteddelay

Parameters

Returns Promise<void>

executeTask

Parameters

Returns Promise<Result<CliResponse, CliError>>

initialize

Returns Promise<void>

dispose

Returns Promise<void>

Settings

On This Page

`Readonly`name

`Protected` `Readonly`parser

`Protected` `Readonly`logger

`Protected`capacityTracker

`Protected`initialized

`Protected` `Optional`lastHealthCheck

`Protected` `Optional`cachedVersion

`Readonly`transport

`Protected` `Readonly`transientRetry

`Protected`getCommand

`Protected`initCapacityTracker

`Protected`recordUsage

`Protected`parseVersion

`Protected`checkVersionCompatibility

`Protected`getVersionMessage

`Protected`createError

`Protected`normalizeResponse

`Protected`delay