From 1c26c272c895ee9109b21e1a8ce9f0203b2f1ffa Mon Sep 17 00:00:00 2001
From: Thibault Sottiaux <tibo@openai.com>
Date: Wed, 16 Apr 2025 10:15:46 -0700
Subject: [PATCH] Add link to cookbook (#2)

---
 codex-cli/src/lib/text-buffer.ts         |  1 +
 codex-cli/src/utils/agent/agent-loop.ts  | 23 +++++++++++------------
 codex-cli/src/utils/agent/apply-patch.ts |  3 +++
 3 files changed, 15 insertions(+), 12 deletions(-)

diff --git a/codex-cli/src/lib/text-buffer.ts b/codex-cli/src/lib/text-buffer.ts
index fb1abf25..43cb6c4e 100644
--- a/codex-cli/src/lib/text-buffer.ts
+++ b/codex-cli/src/lib/text-buffer.ts
@@ -1,4 +1,5 @@
 /* eslint‑disable no-bitwise */
+
 export type Direction =
   | "left"
   | "right"
diff --git a/codex-cli/src/utils/agent/agent-loop.ts b/codex-cli/src/utils/agent/agent-loop.ts
index a0f746a4..5cd1d7b4 100644
--- a/codex-cli/src/utils/agent/agent-loop.ts
+++ b/codex-cli/src/utils/agent/agent-loop.ts
@@ -38,9 +38,7 @@ type AgentLoopParams = {
   onItem: (item: ResponseItem) => void;
   onLoading: (loading: boolean) => void;
 
-  /**
-   * Used to reach out to the user only if the command is not auto-approved.
-   */
+  /** Called when the command is not auto-approved to request explicit user review. */
   getCommandConfirmation: (
     command: Array<string>,
     applyPatch: ApplyPatchCommand | undefined,
@@ -53,12 +51,12 @@ export class AgentLoop {
   private instructions?: string;
   private approvalPolicy: ApprovalPolicy;
   private config: AppConfig;
-  // Using `InstanceType<typeof OpenAI>` sidesteps typing issues with the
-  // OpenAI package under the TS 5+ `moduleResolution=bundler` setup.
-  // OpenAI client instance. We keep the concrete type to avoid sprinkling
-  // `any` across the implementation while still allowing paths where the
-  // OpenAI SDK types may not perfectly match. The `typeof OpenAI` pattern
-  // captures the instance shape without resorting to `any`.
+
+  // Using `InstanceType<typeof OpenAI>` sidesteps typing issues with the OpenAI package under
+  // the TS 5+ `moduleResolution=bundler` setup. OpenAI client instance. We keep the concrete
+  // type to avoid sprinkling `any` across the implementation while still allowing paths where
+  // the OpenAI SDK types may not perfectly match. The `typeof OpenAI` pattern captures the
+  // instance shape without resorting to `any`.
   private oai: OpenAI;
 
   private onItem: (item: ResponseItem) => void;
@@ -688,7 +686,7 @@ export class AgentLoop {
             // process and surface each item (no‑op until we can depend on streaming events)
             if (event.type === "response.output_item.done") {
               const item = event.item;
-              // ① if it's a reasoning item, annotate it
+              // 1) if it's a reasoning item, annotate it
               type ReasoningItem = { type?: string; duration_ms?: number };
               const maybeReasoning = item as ReasoningItem;
               if (maybeReasoning.type === "reasoning") {
@@ -776,7 +774,7 @@ export class AgentLoop {
         // thinking times so UIs and tests can surface/verify them.
         // const thinkingEnd = Date.now();
 
-        // ① Per‑turn measurement – exact time spent between request and
+        // 1) Per‑turn measurement – exact time spent between request and
         //    response for *this* command.
         // this.onItem({
         //   id: `thinking-${thinkingEnd}`,
@@ -792,7 +790,7 @@ export class AgentLoop {
         //   ],
         // });
 
-        // ② Session‑wide cumulative counter so users can track overall wait
+        // 2) Session‑wide cumulative counter so users can track overall wait
         //    time across multiple turns.
         // this.cumulativeThinkingMs += thinkingEnd - thinkingStart;
         // this.onItem({
@@ -975,6 +973,7 @@ export class AgentLoop {
 }
 
 const prefix = `You are operating as and within the Codex CLI, a terminal-based agentic coding assistant built by OpenAI. It wraps OpenAI models to enable natural language interaction with a local codebase. You are expected to be precise, safe, and helpful.
+
 You can:
 - Receive user prompts, project context, and files.
 - Stream responses and emit function calls (e.g., shell commands, code edits).
diff --git a/codex-cli/src/utils/agent/apply-patch.ts b/codex-cli/src/utils/agent/apply-patch.ts
index a0f5e5d1..96443272 100644
--- a/codex-cli/src/utils/agent/apply-patch.ts
+++ b/codex-cli/src/utils/agent/apply-patch.ts
@@ -1,3 +1,6 @@
+// Based on reference implementation from
+// https://cookbook.openai.com/examples/gpt4-1_prompting_guide#reference-implementation-apply_patchpy
+
 import fs from "fs";
 import path from "path";