File tree Expand file tree Collapse file tree 1 file changed +12
-1
lines changed Expand file tree Collapse file tree 1 file changed +12
-1
lines changed Original file line number Diff line number Diff line change @@ -293,7 +293,18 @@ export class CodexCliSession {
293293 }
294294 }
295295
296- static async create ( options : CodexCliSessionOptions ) : Promise < CodexCliSession > {
296+ /**
297+ * Creates a new Codex CLI session for interactive communication
298+ * @param options - Configuration options for the CLI session
299+ * @param options.cliPath - Optional custom path to the Codex CLI binary
300+ * @param options.args - Optional CLI arguments to pass
301+ * @param options.debugEnabled - Enable debug logging
302+ * @param options.debugLogPath - Custom path for debug logs
303+ * @param options.allowNetworkAccess - Allow network access in the session
304+ * @returns Promise resolving to an initialized CodexCliSession
305+ * @throws Error if Codex CLI is not found or fails to initialize
306+ */
307+ static async create ( options : CodexCliSessionOptions ) : Promise < CodexCliSession > {
297308 const resolvedCliPath = await resolveCodexCliPath ( options . cliPath )
298309 if ( ! resolvedCliPath ) {
299310 throw new Error ( "Codex CLI not found. Please install @openai/codex or specify codexCliPath in settings." )
You can’t perform that action at this time.
0 commit comments