Skip to content

docs(codex): align Codex caveats with v1.87.0 auto-discovery behavior#601

Open
Pheobe-Southwood wants to merge 1 commit into
EvoMap:mainfrom
Pheobe-Southwood:docs/align-codex-caveats
Open

docs(codex): align Codex caveats with v1.87.0 auto-discovery behavior#601
Pheobe-Southwood wants to merge 1 commit into
EvoMap:mainfrom
Pheobe-Southwood:docs/align-codex-caveats

Conversation

@Pheobe-Southwood

@Pheobe-Southwood Pheobe-Southwood commented Jul 16, 2026

Copy link
Copy Markdown

Motivation

The Codex caveats section in README.md still claims:

The Codex CLI ... does not emit a session transcript file the way Cursor / Claude Code / opencode do. That means evolver --review cannot read raw session logs on Codex.

This is factually incorrect and was already addressed in v1.87.0 (2026-05-26). The issue was raised in #540 and closed by the maintainer (@autogame-17), but the README was never updated to reflect the fix. The maintainer themselves acknowledged in the issue thread that the previous README description over-promised (承诺面比实际宽).

What actually happened (per #540 closing comment):

  • readCursorTranscripts() was enhanced to auto-discover transcripts under ~/.codex/sessions/ and ~/.claude/projects/ without requiring manual EVOLVER_CURSOR_TRANSCRIPTS_DIR export.
  • readMemoryGraphAnyTail() was added as a tier-2 fallback for memory_graph.jsonl.

Changes

README.md (Codex caveats section)

  • Fixed factual error: Replaced "does not emit a session transcript file" with the accurate statement that Codex writes transcripts to ~/.codex/sessions/*.jsonl, but the Stop hook payload does not include transcript_path.
  • Documented v1.87.0 auto-discovery: Added that Evolver auto-discovers transcripts under ~/.codex/sessions/ (and ~/.claude/projects/ for Claude Code) without manual EVOLVER_CURSOR_TRANSCRIPTS_DIR export.
  • Adjusted wording: Changed "Evolver compensates by reading" to "For additional context, Evolver reads" (transcript discovery is no longer a gap to compensate for, but a working source of session logs).
  • Preserved: lifecycle integration note, 3-layer memory fallback, advisory signals description.

README.zh-CN.md (platform integration section)

  • Added missing Codex platform section: The zh-CN README previously listed only Cursor / Claude Code / OpenClaw — Codex was entirely missing. Added the setup-hooks --platform=codex command, description, and a translated Codex 注意事项 subsection with the same content as the English caveats.

Verification

  • git diff reviewed: 2 files changed, 29 insertions(+), 4 deletions(-)
  • No code changes (docs-only PR); node index.js self-check skipped (no node_modules in fresh clone)

References


Note

Low Risk
Documentation-only changes with no runtime or configuration behavior modified.

Overview
English README: The Codex caveats section no longer claims Codex lacks session transcripts or that evolver --review cannot read Codex logs. It now states that transcripts live under ~/.codex/sessions/*.jsonl, that the Stop hook omits transcript_path, and that since v1.87.0 Evolver auto-discovers those paths (and ~/.claude/projects/ for Claude Code) without EVOLVER_CURSOR_TRANSCRIPTS_DIR. The memory fallback list is reframed from “compensates” to “For additional context, Evolver reads”; proxy/lifecycle notes are unchanged.

Chinese README: Adds a full Codex platform block (setup command, proxy note, caveats, memory fallback, advisory signals) that was missing from README.zh-CN.md, aligned with the updated English text.

Reviewed by Cursor Bugbot for commit b1d1044. Bugbot is set up for automated code reviews on this repo. Configure here.

The Codex caveats section still claims Codex "does not emit a session
transcript file" and that "evolver --review cannot read raw session logs
on Codex". This was addressed in v1.87.0 by evolver-private-dev EvoMap#130
(readCursorTranscripts auto-discovery of ~/.codex/sessions/ and
~/.claude/projects/), but the README was never updated.

- README.md: fix the factually incorrect statement; document that Codex
  writes transcripts to ~/.codex/sessions/*.jsonl and that Evolver
  auto-discovers them since v1.87.0 without requiring manual
  EVOLVER_CURSOR_TRANSCRIPTS_DIR export.
- README.zh-CN.md: add the missing Codex platform section with the
  same caveats, translated to Chinese. The zh-CN README previously had
  no Codex entry at all (only Cursor / Claude Code / OpenClaw).

Refs: EvoMap#540
autogame-17 added a commit that referenced this pull request Jul 16, 2026
Port public PR #601 by Pheobe-Southwood <hannu666@163.com>.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@autogame-17

Copy link
Copy Markdown
Collaborator

Thanks @Pheobe-Southwood — this is a good catch and we accepted it.

I ported the change into the private source repo and synced the public README updates to main in 8ffa889e.

For the contribution reward, please leave your EvoMap account and contact email here, and we will add 200 credits to your account.

Thanks again for keeping the Codex docs accurate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants