openai/codex
1
0
Fork 0
mirror of https://github.com/openai/codex.git synced 2026-09-16 12:13:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge 02a569ac31 into sapling-pr-archive-bolinfest

Browse Source
This commit is contained in:
Michael Bolin
2025-05-16 09:22:47 -07:00
committed by GitHub
parent ab7ccfbfd6 02a569ac31
commit 404c304aff
24 changed files with 493 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.md
View File

@@ -2,6 +2,10 @@
You can install any of these versions: `npm install -g codex@version`
## `0.1.2505160811`
- `codex-mini-latest` (#951)
## `0.1.2505140839`
### 🪲 Bug Fixes

2
codex-cli/src/cli.tsx
View File

@@ -56,7 +56,7 @@ const cli = meow(
--version Print version and exit
-h, --help Show usage and exit
-m, --model <model> Model to use for completions (default: o4-mini)
-m, --model <model> Model to use for completions (default: codex-mini-latest)
-p, --provider <provider> Provider to use for completions (default: openai)
-i, --image <path> Path(s) to image files to include as input
-v, --view <rollout> Inspect a previously saved rollout instead of starting a session

31
codex-cli/src/components/chat/terminal-chat-response-item.tsx
View File

@@ -19,6 +19,7 @@ import { parse, setOptions } from "marked";
import TerminalRenderer from "marked-terminal";
import path from "path";
import React, { useEffect, useMemo } from "react";
import { formatCommandForDisplay } from "src/format-command.js";
import supportsHyperlinks from "supports-hyperlinks";
export default function TerminalChatResponseItem({
@@ -41,8 +42,12 @@ export default function TerminalChatResponseItem({
fileOpener={fileOpener}
/>
);
// @ts-expect-error new item types aren't in SDK yet
case "local_shell_call":
case "function_call":
return <TerminalChatResponseToolCall message={item} />;
// @ts-expect-error new item types aren't in SDK yet
case "local_shell_call_output":
case "function_call_output":
return (
<TerminalChatResponseToolCallOutput
@@ -166,21 +171,28 @@ function TerminalChatResponseMessage({
function TerminalChatResponseToolCall({
message,
}: {
message: ResponseFunctionToolCallItem;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
message: ResponseFunctionToolCallItem | any;
}) {
const details = parseToolCall(message);
let workdir: string | undefined;
let cmdReadableText: string | undefined;
if (message.type === "function_call") {
const details = parseToolCall(message);
workdir = details?.workdir;
cmdReadableText = details?.cmdReadableText;
} else if (message.type === "local_shell_call") {
const action = message.action;
workdir = action.working_directory;
cmdReadableText = formatCommandForDisplay(action.command);
}
return (
<Box flexDirection="column" gap={1}>
<Text color="magentaBright" bold>
command
{details?.workdir ? (
<Text dimColor>{` (${details?.workdir})`}</Text>
) : (
""
)}
{workdir ? <Text dimColor>{` (${workdir})`}</Text> : ""}
</Text>
<Text>
<Text dimColor>$</Text> {details?.cmdReadableText}
<Text dimColor>$</Text> {cmdReadableText}
</Text>
</Box>
);
@@ -190,7 +202,8 @@ function TerminalChatResponseToolCallOutput({
message,
fullStdout,
}: {
message: ResponseFunctionToolCallOutputItem;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
message: ResponseFunctionToolCallOutputItem | any;
fullStdout: boolean;
}) {
const { output, metadata } = parseToolCallOutput(message.output);

108
codex-cli/src/utils/agent/agent-loop.ts
View File

@@ -8,6 +8,7 @@ import type {
ResponseItem,
ResponseCreateParams,
FunctionTool,
Tool,
} from "openai/resources/responses/responses.mjs";
import type { Reasoning } from "openai/resources.mjs";
@@ -84,7 +85,7 @@ type AgentLoopParams = {
onLastResponseId: (lastResponseId: string) => void;
};
const shellTool: FunctionTool = {
const shellFunctionTool: FunctionTool = {
type: "function",
name: "shell",
description: "Runs a shell command, and returns its output.",
@@ -108,6 +109,11 @@ const shellTool: FunctionTool = {
},
};
const localShellTool: Tool = {
//@ts-expect-error - waiting on sdk
type: "local_shell",
};
export class AgentLoop {
private model: string;
private provider: string;
@@ -461,6 +467,73 @@ export class AgentLoop {
return [outputItem, ...additionalItems];
}
private async handleLocalShellCall(
// eslint-disable-next-line @typescript-eslint/no-explicit-any
item: any,
): Promise<Array<ResponseInputItem>> {
// If the agent has been canceled in the meantime we should not perform any
// additional work. Returning an empty array ensures that we neither execute
// the requested tool call nor enqueue any follow‑up input items. This keeps
// the cancellation semantics intuitive for users – once they interrupt a
// task no further actions related to that task should be taken.
if (this.canceled) {
return [];
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const outputItem: any = {
type: "local_shell_call_output",
// `call_id` is mandatory – ensure we never send `undefined` which would
// trigger the "No tool output found…" 400 from the API.
call_id: item.call_id,
output: "no function found",
};
// We intentionally *do not* remove this `callId` from the `pendingAborts`
// set right away. The output produced below is only queued up for the
// *next* request to the OpenAI API – it has not been delivered yet. If
// the user presses ESC‑ESC (i.e. invokes `cancel()`) in the small window
// between queuing the result and the actual network call, we need to be
// able to surface a synthetic `function_call_output` marked as
// "aborted". Keeping the ID in the set until the run concludes
// successfully lets the next `run()` differentiate between an aborted
// tool call (needs the synthetic output) and a completed one (cleared
// below in the `flush()` helper).
// used to tell model to stop if needed
const additionalItems: Array<ResponseInputItem> = [];
if (item.action.type !== "exec") {
throw new Error("Invalid action type");
}
const args = {
cmd: item.action.command,
workdir: item.action.working_directory,
timeoutInMillis: item.action.timeout_ms,
};
const {
outputText,
metadata,
additionalItems: additionalItemsFromExec,
} = await handleExecCommand(
args,
this.config,
this.approvalPolicy,
this.additionalWritableRoots,
this.getCommandConfirmation,
this.execAbortController?.signal,
);
outputItem.output = JSON.stringify({ output: outputText, metadata });
if (additionalItemsFromExec) {
additionalItems.push(...additionalItemsFromExec);
}
return [outputItem, ...additionalItems];
}
public async run(
input: Array<ResponseInputItem>,
previousResponseId: string = "",
@@ -545,6 +618,11 @@ export class AgentLoop {
// `disableResponseStorage === true`.
let transcriptPrefixLen = 0;
let tools: Array<Tool> = [shellFunctionTool];
if (this.model.startsWith("codex")) {
tools = [localShellTool];
}
const stripInternalFields = (
item: ResponseInputItem,
): ResponseInputItem => {
@@ -648,6 +726,8 @@ export class AgentLoop {
if (
(item as ResponseInputItem).type === "function_call" ||
(item as ResponseInputItem).type === "reasoning" ||
//@ts-expect-error - waiting on sdk
(item as ResponseInputItem).type === "local_shell_call" ||
((item as ResponseInputItem).type === "message" &&
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(item as any).role === "user")
@@ -748,7 +828,7 @@ export class AgentLoop {
store: true,
previous_response_id: lastResponseId || undefined,
}),
tools: [shellTool],
tools: tools,
// Explicitly tell the model it is allowed to pick whatever
// tool it deems appropriate. Omitting this sometimes leads to
// the model ignoring the available tools and responding with
@@ -968,7 +1048,10 @@ export class AgentLoop {
if (maybeReasoning.type === "reasoning") {
maybeReasoning.duration_ms = Date.now() - thinkingStart;
}
if (item.type === "function_call") {
if (
item.type === "function_call" ||
item.type === "local_shell_call"
) {
// Track outstanding tool call so we can abort later if needed.
// The item comes from the streaming response, therefore it has
// either `id` (chat) or `call_id` (responses) – we normalise
@@ -1091,7 +1174,11 @@ export class AgentLoop {
let reasoning: Reasoning | undefined;
if (this.model.startsWith("o")) {
reasoning = { effort: "high" };
if (this.model === "o3" || this.model === "o4-mini") {
if (
this.model === "o3" ||
this.model === "o4-mini" ||
this.model === "codex-mini-latest"
) {
reasoning.summary = "auto";
}
}
@@ -1130,7 +1217,7 @@ export class AgentLoop {
store: true,
previous_response_id: lastResponseId || undefined,
}),
tools: [shellTool],
tools: tools,
tool_choice: "auto",
});
@@ -1492,6 +1579,17 @@ export class AgentLoop {
// eslint-disable-next-line no-await-in-loop
const result = await this.handleFunctionCall(item);
turnInput.push(...result);
//@ts-expect-error - waiting on sdk
} else if (item.type === "local_shell_call") {
//@ts-expect-error - waiting on sdk
if (alreadyProcessedResponses.has(item.id)) {
continue;
}
//@ts-expect-error - waiting on sdk
alreadyProcessedResponses.add(item.id);
// eslint-disable-next-line no-await-in-loop
const result = await this.handleLocalShellCall(item);
turnInput.push(...result);
}
emitItem(item as ResponseItem);
}

2
codex-cli/src/utils/config.ts
View File

@@ -43,7 +43,7 @@ if (!isVitest) {
loadDotenv({ path: USER_WIDE_CONFIG_PATH });
}
export const DEFAULT_AGENTIC_MODEL = "o4-mini";
export const DEFAULT_AGENTIC_MODEL = "codex-mini-latest";
export const DEFAULT_FULL_CONTEXT_MODEL = "gpt-4.1";
export const DEFAULT_APPROVAL_MODE = AutoApprovalMode.SUGGEST;
export const DEFAULT_INSTRUCTIONS = "";

20
codex-cli/src/utils/get-diff.ts
View File

@@ -1,4 +1,4 @@
import { execSync } from "node:child_process";
import { execSync, execFileSync } from "node:child_process";
// The objects thrown by `child_process.execSync()` are `Error` instances that
// include additional, undocumented properties such as `status` (exit code) and
@@ -89,12 +89,18 @@ export function getGitDiff(): {
//
// `git diff --color --no-index /dev/null <file>` exits with status 1
// when differences are found, so we capture stdout from the thrown
// error object instead of letting it propagate.
execSync(`git diff --color --no-index -- "${nullDevice}" "${file}"`, {
encoding: "utf8",
stdio: ["ignore", "pipe", "ignore"],
maxBuffer: 10 * 1024 * 1024,
});
// error object instead of letting it propagate. Using `execFileSync`
// avoids shell interpolation issues with special characters in the
// path.
execFileSync(
"git",
["diff", "--color", "--no-index", "--", nullDevice, file],
{
encoding: "utf8",
stdio: ["ignore", "pipe", "ignore"],
maxBuffer: 10 * 1024 * 1024,
},
);
} catch (err) {
if (
isExecSyncError(err) &&

4
codex-cli/src/utils/model-info.ts
View File

@@ -19,6 +19,10 @@ export const openAiModelInfo = {
label: "o3 (2025-04-16)",
maxContextLength: 200000,
},
"codex-mini-latest": {
label: "codex-mini-latest",
maxContextLength: 200000,
},
"o4-mini": {
label: "o4 Mini",
maxContextLength: 200000,

2
codex-cli/tests/config.test.tsx
View File

@@ -67,7 +67,7 @@ test("loads default config if files don't exist", () => {
});
// Keep the test focused on just checking that default model and instructions are loaded
// so we need to make sure we check just these properties
expect(config.model).toBe("o4-mini");
expect(config.model).toBe("codex-mini-latest");
expect(config.instructions).toBe("");
});

2
codex-cli/tests/disableResponseStorage.agentLoop.test.ts
View File

@@ -29,7 +29,7 @@ describe.each([
])("AgentLoop with disableResponseStorage=%s", ({ flag, title }) => {
/* build a fresh config for each case */
const cfg: AppConfig = {
model: "o4-mini",
model: "codex-mini-latest",
provider: "openai",
instructions: "",
disableResponseStorage: flag,

5
codex-cli/tests/disableResponseStorage.test.ts
View File

@@ -21,7 +21,10 @@ describe("disableResponseStorage persistence", () => {
mkdirSync(codexDir, { recursive: true });
// seed YAML with ZDR enabled
writeFileSync(yamlPath, "model: o4-mini\ndisableResponseStorage: true\n");
writeFileSync(
yamlPath,
"model: codex-mini-latest\ndisableResponseStorage: true\n",
);
});
afterAll((): void => {

28
codex-cli/tests/get-diff-special-chars.test.ts Normal file
View File

@@ -0,0 +1,28 @@
import { mkdtempSync, writeFileSync, rmSync } from "fs";
import { tmpdir } from "os";
import { join } from "path";
import { execSync } from "child_process";
import { describe, it, expect } from "vitest";
import { getGitDiff } from "../src/utils/get-diff.js";
describe("getGitDiff", () => {
it("handles untracked files with special characters", () => {
const repoDir = mkdtempSync(join(tmpdir(), "git-diff-test-"));
const prevCwd = process.cwd();
try {
process.chdir(repoDir);
execSync("git init", { stdio: "ignore" });
const fileName = "a$b.txt";
writeFileSync(join(repoDir, fileName), "hello\n");
const { isGitRepo, diff } = getGitDiff();
expect(isGitRepo).toBe(true);
expect(diff).toContain(fileName);
} finally {
process.chdir(prevCwd);
rmSync(repoDir, { recursive: true, force: true });
}
});
});

5
codex-cli/tests/model-utils-network-error.test.ts
View File

@@ -44,7 +44,10 @@ describe("model-utils – offline resilience", () => {
"../src/utils/model-utils.js"
);
const supported = await isModelSupportedForResponses("openai", "o4-mini");
const supported = await isModelSupportedForResponses(
"openai",
"codex-mini-latest",
);
expect(supported).toBe(true);
});

3
codex-rs/Cargo.lock generated
View File

@@ -629,8 +629,11 @@ dependencies = [
"codex-core",
"color-eyre",
"crossterm",
"lazy_static",
"mcp-types",
"pretty_assertions",
"ratatui",
"regex",
"serde_json",
"shlex",
"strum 0.27.1",

13
codex-rs/README.md
View File

@@ -310,6 +310,19 @@ To disable this behavior, configure `[history]` as follows:
persistence = "none" # "save-all" is the default value
```
### file_opener
Identifies the editor/URI scheme to use for hyperlinking citations in model output. If set, citations to files in the model output will be hyperlinked using the specified URI scheme so they can be ctrl/cmd-clicked from the terminal to open them.
For example, if the model output includes a refrence such as `【F:/home/user/project/main.py†L42-L50】`, then this would be rewritten to link to the URI `vscode://file/home/user/project/main.py:42`.
Note this is **not** a general editor setting (like `$EDITOR`), as it only accepts a fixed set of values:
- `vscode` (default)
- `vscode-insiders`
- `windsurf`
- `cursor`
### project_doc_max_bytes
Maximum number of bytes to read from an `AGENTS.md` file to include in the instructions sent with the first turn of a session. Defaults to 32 KiB.

96
codex-rs/apply-patch/src/lib.rs
View File

@@ -18,7 +18,7 @@ use thiserror::Error;
use tree_sitter::Parser;
use tree_sitter_bash::LANGUAGE as BASH;
#[derive(Debug, Error)]
#[derive(Debug, Error, PartialEq)]
pub enum ApplyPatchError {
#[error(transparent)]
ParseError(#[from] ParseError),
@@ -46,6 +46,12 @@ pub struct IoError {
source: std::io::Error,
}
impl PartialEq for IoError {
fn eq(&self, other: &Self) -> bool {
self.context == other.context && self.source.to_string() == other.source.to_string()
}
}
#[derive(Debug)]
pub enum MaybeApplyPatch {
Body(Vec<Hunk>),
@@ -77,7 +83,7 @@ pub fn maybe_parse_apply_patch(argv: &[String]) -> MaybeApplyPatch {
}
}
#[derive(Debug)]
#[derive(Debug, PartialEq)]
pub enum ApplyPatchFileChange {
Add {
content: String,
@@ -106,7 +112,27 @@ pub enum MaybeApplyPatchVerified {
NotApplyPatch,
}
#[derive(Debug)]
impl PartialEq for MaybeApplyPatchVerified {
fn eq(&self, other: &Self) -> bool {
match (self, other) {
(MaybeApplyPatchVerified::Body(a), MaybeApplyPatchVerified::Body(b)) => a == b,
(
MaybeApplyPatchVerified::ShellParseError(a),
MaybeApplyPatchVerified::ShellParseError(b),
) => a.to_string() == b.to_string(),
(
MaybeApplyPatchVerified::CorrectnessError(a),
MaybeApplyPatchVerified::CorrectnessError(b),
) => a == b,
(MaybeApplyPatchVerified::NotApplyPatch, MaybeApplyPatchVerified::NotApplyPatch) => {
true
}
_ => false,
}
}
}
#[derive(Debug, PartialEq)]
/// ApplyPatchAction is the result of parsing an `apply_patch` command. By
/// construction, all paths should be absolute paths.
pub struct ApplyPatchAction {
@@ -142,22 +168,16 @@ pub fn maybe_parse_apply_patch_verified(argv: &[String], cwd: &Path) -> MaybeApp
MaybeApplyPatch::Body(hunks) => {
let mut changes = HashMap::new();
for hunk in hunks {
let path = hunk.resolve_path(cwd);
match hunk {
Hunk::AddFile { path, contents } => {
changes.insert(
cwd.join(path),
ApplyPatchFileChange::Add {
content: contents.clone(),
},
);
Hunk::AddFile { contents, .. } => {
changes.insert(path, ApplyPatchFileChange::Add { content: contents });
}
Hunk::DeleteFile { path } => {
changes.insert(cwd.join(path), ApplyPatchFileChange::Delete);
Hunk::DeleteFile { .. } => {
changes.insert(path, ApplyPatchFileChange::Delete);
}
Hunk::UpdateFile {
path,
move_path,
chunks,
move_path, chunks, ..
} => {
let ApplyPatchFileUpdate {
unified_diff,
@@ -169,7 +189,7 @@ pub fn maybe_parse_apply_patch_verified(argv: &[String], cwd: &Path) -> MaybeApp
}
};
changes.insert(
cwd.join(path),
path,
ApplyPatchFileChange::Update {
unified_diff,
move_path: move_path.map(|p| cwd.join(p)),
@@ -1137,4 +1157,48 @@ g
"#
);
}
#[test]
fn test_apply_patch_should_resolve_absolute_paths_in_cwd() {
let session_dir = tempdir().unwrap();
let relative_path = "source.txt";
// Note that we need this file to exist for the patch to be "verified"
// and parsed correctly.
let session_file_path = session_dir.path().join(relative_path);
fs::write(&session_file_path, "session directory content\n").unwrap();
let argv = vec![
"apply_patch".to_string(),
r#"*** Begin Patch
*** Update File: source.txt
@@
-session directory content
+updated session directory content
*** End Patch"#
.to_string(),
];
let result = maybe_parse_apply_patch_verified(&argv, session_dir.path());
// Verify the patch contents - as otherwise we may have pulled contents
// from the wrong file (as we're using relative paths)
assert_eq!(
result,
MaybeApplyPatchVerified::Body(ApplyPatchAction {
changes: HashMap::from([(
session_dir.path().join(relative_path),
ApplyPatchFileChange::Update {
unified_diff: r#"@@ -1 +1 @@
-session directory content
+updated session directory content
"#
.to_string(),
move_path: None,
new_content: "updated session directory content\n".to_string(),
},
)]),
})
);
}
}

12
codex-rs/apply-patch/src/parser.rs
View File

@@ -22,6 +22,7 @@
//!
//! The parser below is a little more lenient than the explicit spec and allows for
//! leading/trailing whitespace around patch markers.
use std::path::Path;
use std::path::PathBuf;
use thiserror::Error;
@@ -64,6 +65,17 @@ pub enum Hunk {
chunks: Vec<UpdateFileChunk>,
},
}
impl Hunk {
pub fn resolve_path(&self, cwd: &Path) -> PathBuf {
match self {
Hunk::AddFile { path, .. } => cwd.join(path),
Hunk::DeleteFile { path } => cwd.join(path),
Hunk::UpdateFile { path, .. } => cwd.join(path),
}
}
}
use Hunk::*;
#[derive(Debug, PartialEq)]

31
codex-rs/core/src/config.rs
View File

@@ -84,6 +84,10 @@ pub struct Config {
/// Settings that govern if and what will be written to `~/.codex/history.jsonl`.
pub history: History,
/// Optional URI-based file opener. If set, citations to files in the model
/// output will be hyperlinked using the specified URI scheme.
pub file_opener: Option<UriBasedFileOpener>,
}
/// Settings that govern if and what will be written to `~/.codex/history.jsonl`.
@@ -97,7 +101,7 @@ pub struct History {
pub max_bytes: Option<usize>,
}
#[derive(Deserialize, Debug, Clone, PartialEq, Default)]
#[derive(Deserialize, Debug, Copy, Clone, PartialEq, Default)]
#[serde(rename_all = "kebab-case")]
pub enum HistoryPersistence {
/// Save all history entries to disk.
@@ -107,6 +111,21 @@ pub enum HistoryPersistence {
None,
}
#[derive(Deserialize, Debug, Copy, Clone, PartialEq)]
pub enum UriBasedFileOpener {
#[serde(rename = "vscode")]
VsCode,
#[serde(rename = "vscode-insiders")]
VsCodeInsiders,
#[serde(rename = "windsurf")]
Windsurf,
#[serde(rename = "cursor")]
Cursor,
}
/// Base config deserialized from ~/.codex/config.toml.
#[derive(Deserialize, Debug, Clone, Default)]
pub struct ConfigToml {
@@ -158,6 +177,10 @@ pub struct ConfigToml {
/// Settings that govern if and what will be written to `~/.codex/history.jsonl`.
#[serde(default)]
pub history: Option<History>,
/// Optional URI-based file opener. If set, citations to files in the model
/// output will be hyperlinked using the specified URI scheme.
pub file_opener: Option<UriBasedFileOpener>,
}
impl ConfigToml {
@@ -351,6 +374,9 @@ impl Config {
project_doc_max_bytes: cfg.project_doc_max_bytes.unwrap_or(PROJECT_DOC_MAX_BYTES),
codex_home,
history,
// TODO(mbolin): Check if user has VS Code installed before
// defaulting to it?
file_opener: cfg.file_opener.or(Some(UriBasedFileOpener::VsCode)),
};
Ok(config)
}
@@ -686,6 +712,7 @@ disable_response_storage = true
project_doc_max_bytes: PROJECT_DOC_MAX_BYTES,
codex_home: fixture.codex_home(),
history: History::default(),
file_opener: Some(UriBasedFileOpener::VsCode),
},
o3_profile_config
);
@@ -721,6 +748,7 @@ disable_response_storage = true
project_doc_max_bytes: PROJECT_DOC_MAX_BYTES,
codex_home: fixture.codex_home(),
history: History::default(),
file_opener: Some(UriBasedFileOpener::VsCode),
};
assert_eq!(expected_gpt3_profile_config, gpt3_profile_config);
@@ -771,6 +799,7 @@ disable_response_storage = true
project_doc_max_bytes: PROJECT_DOC_MAX_BYTES,
codex_home: fixture.codex_home(),
history: History::default(),
file_opener: Some(UriBasedFileOpener::VsCode),
};
assert_eq!(expected_zdr_profile_config, zdr_profile_config);

7
codex-rs/tui/Cargo.toml
View File

@@ -22,11 +22,13 @@ codex-core = { path = "../core" }
codex-common = { path = "../common", features = ["cli", "elapsed"] }
color-eyre = "0.6.3"
crossterm = { version = "0.28.1", features = ["bracketed-paste"] }
lazy_static = "1"
mcp-types = { path = "../mcp-types" }
ratatui = { version = "0.29.0", features = [
"unstable-widget-ref",
"unstable-rendered-line-info",
] }
regex = "1"
serde_json = "1"
shlex = "1.3.0"
strum = "0.27.1"
@@ -44,4 +46,7 @@ tracing-subscriber = { version = "0.3.19", features = ["env-filter"] }
tui-input = "0.11.1"
tui-markdown = "0.3.3"
tui-textarea = "0.7.0"
uuid = { version = "1" }
uuid = "1"
[dev-dependencies]
pretty_assertions = "1"

6
codex-rs/tui/src/chatwidget.rs
View File

@@ -209,11 +209,13 @@ impl ChatWidget<'_> {
self.request_redraw();
}
EventMsg::AgentMessage(AgentMessageEvent { message }) => {
self.conversation_history.add_agent_message(message);
self.conversation_history
.add_agent_message(&self.config, message);
self.request_redraw();
}
EventMsg::AgentReasoning(AgentReasoningEvent { text }) => {
self.conversation_history.add_agent_reasoning(text);
self.conversation_history
.add_agent_reasoning(&self.config, text);
self.request_redraw();
}
EventMsg::TaskStarted => {

23
codex-rs/tui/src/citation_regex.rs Normal file
View File

@@ -0,0 +1,23 @@
#![allow(clippy::expect_used)]
use regex::Regex;
// This is defined in its own file so we can limit the scope of
// `allow(clippy::expect_used)` because we cannot scope it to the `lazy_static!`
// macro.
lazy_static::lazy_static! {
/// Regular expression that matches Codex-style source file citations such as:
///
/// ```text
/// 【F:src/main.rs†L10-L20】
/// ```
///
/// Capture groups:
/// 1. file path (anything except the dagger `†` symbol)
/// 2. start line number (digits)
/// 3. optional end line (digits or `?`)
#[allow(clippy::expect_used)]
pub(crate) static ref CITATION_REGEX: Regex = Regex::new(
r"【F:([^†]+)†L(\d+)(?:-L(\d+|\?))?】"
).expect("failed to compile citation regex");
}

8
codex-rs/tui/src/conversation_history_widget.rs
View File

@@ -183,12 +183,12 @@ impl ConversationHistoryWidget {
self.add_to_history(HistoryCell::new_user_prompt(message));
}
pub fn add_agent_message(&mut self, message: String) {
self.add_to_history(HistoryCell::new_agent_message(message));
pub fn add_agent_message(&mut self, config: &Config, message: String) {
self.add_to_history(HistoryCell::new_agent_message(config, message));
}
pub fn add_agent_reasoning(&mut self, text: String) {
self.add_to_history(HistoryCell::new_agent_reasoning(text));
pub fn add_agent_reasoning(&mut self, config: &Config, text: String) {
self.add_to_history(HistoryCell::new_agent_reasoning(config, text));
}
pub fn add_background_event(&mut self, message: String) {

8
codex-rs/tui/src/history_cell.rs
View File

@@ -155,19 +155,19 @@ impl HistoryCell {
HistoryCell::UserPrompt { lines }
}
pub(crate) fn new_agent_message(message: String) -> Self {
pub(crate) fn new_agent_message(config: &Config, message: String) -> Self {
let mut lines: Vec<Line<'static>> = Vec::new();
lines.push(Line::from("codex".magenta().bold()));
append_markdown(&message, &mut lines);
append_markdown(&message, &mut lines, config.file_opener, &config.cwd);
lines.push(Line::from(""));
HistoryCell::AgentMessage { lines }
}
pub(crate) fn new_agent_reasoning(text: String) -> Self {
pub(crate) fn new_agent_reasoning(config: &Config, text: String) -> Self {
let mut lines: Vec<Line<'static>> = Vec::new();
lines.push(Line::from("thinking".magenta().italic()));
append_markdown(&text, &mut lines);
append_markdown(&text, &mut lines, config.file_opener, &config.cwd);
lines.push(Line::from(""));
HistoryCell::AgentReasoning { lines }

1
codex-rs/tui/src/lib.rs
View File

@@ -19,6 +19,7 @@ mod app_event;
mod app_event_sender;
mod bottom_pane;
mod chatwidget;
mod citation_regex;
mod cli;
mod conversation_history_widget;
mod exec_command;

129
codex-rs/tui/src/markdown.rs
View File

@@ -1,8 +1,36 @@
use codex_core::config::UriBasedFileOpener;
use ratatui::text::Line;
use ratatui::text::Span;
use std::path::Path;
use std::path::PathBuf;
pub(crate) fn append_markdown(markdown_source: &str, lines: &mut Vec<Line<'static>>) {
let markdown = tui_markdown::from_str(markdown_source);
use crate::citation_regex::CITATION_REGEX;
/// Convert the provided markdown to [`ratatui`] [`Line`]s and append them to
/// `lines`. Before rendering we rewrite Codex-style file citations of the form
/// `【F:path/to/file†L10-L20】` into standard markdown hyperlinks that IDEs such
/// as VS Code can interpret when combined with the "URI-based file opener"
/// functionality.
///
/// The specific URI scheme to use is determined by `file_opener` (e.g.
/// `vscode`, `vscode-insiders`, `cursor`, `windsurf`). When it is `None` the
/// citations are **left unchanged** so they still render as plain text.
pub(crate) fn append_markdown(
markdown_source: &str,
lines: &mut Vec<Line<'static>>,
file_opener: Option<UriBasedFileOpener>,
cwd: &Path,
) {
// Perform citation rewrite *before* feeding the string to the markdown
// renderer. When `file_opener` is absent we bypass the transformation to
// avoid unnecessary allocations.
let processed_markdown: std::borrow::Cow<'_, str> = if let Some(scheme) = file_opener {
std::borrow::Cow::Owned(rewrite_file_citations(markdown_source, scheme, cwd))
} else {
std::borrow::Cow::Borrowed(markdown_source)
};
let markdown = tui_markdown::from_str(&processed_markdown);
// `tui_markdown` returns a `ratatui::text::Text` where every `Line` borrows
// from the input `message` string. Since the `HistoryCell` stores its lines
@@ -28,3 +56,100 @@ pub(crate) fn append_markdown(markdown_source: &str, lines: &mut Vec<Line<'stati
lines.push(owned_line);
}
}
/// Rewrites file citations in `src` into markdown hyperlinks using the
/// provided `scheme` (`vscode`, `cursor`, etc.). The resulting URI follows the
/// format expected by VS Code-compatible file openers:
///
/// ```text
/// <scheme>://file<ABS_PATH>:<LINE>
/// ```
fn rewrite_file_citations(src: &str, scheme: UriBasedFileOpener, cwd: &Path) -> String {
// Map enum values to the corresponding URI scheme strings.
let scheme_str: &str = match scheme {
UriBasedFileOpener::VsCode => "vscode",
UriBasedFileOpener::VsCodeInsiders => "vscode-insiders",
UriBasedFileOpener::Windsurf => "windsurf",
UriBasedFileOpener::Cursor => "cursor",
};
CITATION_REGEX
.replace_all(src, |caps: &regex::Captures<'_>| {
let file = &caps[1];
let start_line = &caps[2];
// Resolve the path against `cwd` when it is relative.
let path = {
let p = Path::new(file);
if p.is_absolute() {
PathBuf::from(p)
} else {
cwd.join(p)
}
};
// VS Code expects forward slashes even on Windows because URIs use
// `/` as the path separator.
let abs = path.to_string_lossy().replace('\\', "/");
// Render as a normal markdown link so the downstream renderer emits
// the hyperlink escape sequence (when supported by the terminal).
format!("[{}]({}://file{}:{})", file, scheme_str, abs, start_line)
})
.into_owned()
}
// ---------------------------------------------------------------------------
// Tests
// ---------------------------------------------------------------------------
#[cfg(test)]
mod tests {
use super::*;
use pretty_assertions::assert_eq;
#[test]
fn citation_is_rewritten_with_absolute_path() {
let markdown = "See 【F:/src/main.rs†L42-L50】 for details.";
let cwd = Path::new("/workspace");
let result = rewrite_file_citations(markdown, UriBasedFileOpener::VsCode, cwd);
assert_eq!(
"See [/src/main.rs](vscode://file/src/main.rs:42) for details.",
result
);
}
#[test]
fn citation_is_rewritten_with_relative_path() {
let markdown = "Refer to 【F:lib/mod.rs†L5】 here.";
let cwd = Path::new("/home/user/project");
let result = rewrite_file_citations(markdown, UriBasedFileOpener::Cursor, cwd);
assert_eq!(
"Refer to [lib/mod.rs](cursor://file/home/user/project/lib/mod.rs:5) here.",
result
);
}
#[test]
fn citation_unchanged_without_file_opener() {
let markdown = "Look at 【F:file.rs†L1】.";
let cwd = Path::new("/");
let unchanged = rewrite_file_citations(markdown, UriBasedFileOpener::VsCode, cwd);
// The helper itself always rewrites – this test validates behaviour of
// append_markdown when `file_opener` is None.
let mut out = Vec::new();
append_markdown(markdown, &mut out, None, cwd);
// Convert lines back to string for comparison.
let rendered: String = out
.iter()
.flat_map(|l| l.spans.iter())
.map(|s| s.content.clone())
.collect::<Vec<_>>()
.join("");
assert_eq!(markdown, rendered);
// Ensure helper rewrites.
assert_ne!(markdown, unchanged);
}
}