Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

@sms/model-gpt

Interfaces

GptModelOptions

Defined in: packages/drivers/model/gpt/src/index.ts:49

Properties

codexPath?
optional codexPath?: string;

Defined in: packages/drivers/model/gpt/src/index.ts:58

Path to a codex binary; default: the one bundled with @openai/codex-sdk.

cwd?
optional cwd?: string;

Defined in: packages/drivers/model/gpt/src/index.ts:54

Working directory for the CLI’s sandbox. Default: an empty temp directory.

debug?
optional debug?: (...args) => void;

Defined in: packages/drivers/model/gpt/src/index.ts:62

Optional debug logger.

Parameters
ParameterType
argsunknown[]
Returns

void

effort?
optional effort?: ModelReasoningEffort;

Defined in: packages/drivers/model/gpt/src/index.ts:52

env?
optional env?: Record<string, string | undefined>;

Defined in: packages/drivers/model/gpt/src/index.ts:60

Environment for the CLI process; default: process.env. Must contain the login (~/.codex).

model?
optional model?: string;

Defined in: packages/drivers/model/gpt/src/index.ts:51

Model id understood by the Codex CLI (e.g. ‘gpt-5.5’, ‘gpt-5.5-codex’). Default: the CLI’s.

sandbox?
optional sandbox?: SandboxMode;

Defined in: packages/drivers/model/gpt/src/index.ts:56

Codex sandbox for its built-in shell tools. Default: ‘read-only’.

Functions

createGptModel()

function createGptModel(opts?): ModelService & {
  close: void;
};

Defined in: packages/drivers/model/gpt/src/index.ts:274

Parameters

ParameterType
optsGptModelOptions

Returns

ModelService & { close: void; }


createGptModelPlugin()

function createGptModelPlugin(opts?): SystemPlugin;

Defined in: packages/drivers/model/gpt/src/index.ts:294

Parameters

ParameterType
optsGptModelOptions

Returns

SystemPlugin