CodexSettings

import type { CodexSettings } from "@elie-laloum/outpost";

Parameters and properties

modelProviderOptional
CodexModelProvider | undefined
Custom Responses-compatible endpoint used instead of OpenAI. It requires a model name on createAgent() and accepts only usage authentication; both are checked when the agent is composed.
approvalReviewerOptional
"user" | "auto_review" | undefined
auto_review lets Codex’s automatic reviewer decide approval requests, with full file access. Otherwise headless runs bypass approvals and interactive sessions keep the CLI’s prompts.
authenticationOptional
AgentAuthentication | undefined
Credential selection: “account” (subscription login), “usage” (API key), { account: { file | key | variable } } or { usage: { key | variable } }. Codex rejects account key and variable and accepts only usage with modelProvider; unsupported forms fail when the agent is composed. Omitted, Outpost installs no credentials.
variablesOptional
Readonly<Record<string, string>> | undefined
Environment variables for this CLI’s commands, merged over .outpost/.env; a name also set by the sandbox provider fails with code configuration. Claude Code rejects CLAUDE_CODE_MAX_OUTPUT_TOKENS or MCP_TIMEOUT here when maxOutputTokens or startupTimeoutMs already sets it.
saveConversationsOptional
boolean | undefined
Save the native conversation after each turn, default true. false disables capture and cannot be combined with conversations.
conversationsOptional
ConversationStore | undefined
Conversation store used instead of the native one, such as createTransportConversations() over the agent’s format. A store of another format, or saveConversations: false, fails when the harness is created.
mcpServersOptional
McpServers | undefined
MCP servers keyed by name, passed on the command line: —mcp-config for Claude Code, -c overrides for Codex. Secrets stay variable references; an undeclared referenced variable fails before the agent starts.

Signature

export interface CodexSettings extends CommonAgentSettings {
  readonly modelProvider?: CodexModelProvider;
  readonly approvalReviewer?: "user" | "auto_review";
}

Parameters and properties

Signature

Related contracts