Skip to content

docs(agenteye): add Codex session capture page#592

Merged
NiveditJain merged 2 commits into
mainfrom
docs/agenteye-codex-capture
Jul 24, 2026
Merged

docs(agenteye): add Codex session capture page#592
NiveditJain merged 2 commits into
mainfrom
docs/agenteye-codex-capture

Conversation

@NiveditJain

@NiveditJain NiveditJain commented Jul 24, 2026

Copy link
Copy Markdown
Member

What

Adds a public docs page for Codex session capture — the collector feature that tails a developer's local OpenAI Codex sessions into AgentEye as ordinary sessions and events.

The feature shipped in the collector but had no public documentation (the docs/agenteye/ set had nothing on the collector or Codex capture). This fills that gap.

Page

docs/agenteye/codex-capture.mdx, registered in the en SDK and CLI nav group (alongside the Python SDK). It covers:

  • What it captures — CLI, IDE extension, and local desktop-app sessions; what becomes a session vs. an event; and that Codex cloud sessions are not captured.
  • Turn it on — install the collector with an events:add API key and --codex-enabled, then verify with health.
  • Where it shows up — Sessions + Events, with links to replay/search/evaluations/alerts.
  • Privacy — transcripts can contain secrets and are shipped as-is; scope the key to events:add.

Audience / confidentiality

Written for the public reader (evaluating the product): value and the public CLI contract only — install command, flags, events:add permission name, observable behaviour. No implementation detail — no file paths, env vars, service internals, or architecture. Those live in the enterprise docs.

Validation

  • bun run validate:mdx676 pages parsed cleanly (incl. the new page).
  • docs.json parses; the new nav entry resolves to the new file and is present in en only (locale nav entries are generated by the translation cron — not hand-added).
  • mintlify validate runs in this repo's docs CI job (its local puppeteer/chrome step isn't available in my sandbox).

Translations are intentionally omitted — translate-docs.yml generates the 14 locales and their nav entries on its next run.

Summary by CodeRabbit

  • Documentation
    • Added a new “Codex session capture” guide describing how to ingest OpenAI Codex local transcripts into AgentEye, including what data is captured (messages, reasoning, tool activity/results, and token usage).
    • Covered opt-in enablement (including required event permissions), one-time backfill, ongoing streaming, and restart-safe delivery guarantees.
    • Clarified that Codex cloud sessions aren’t captured and highlighted privacy considerations.
    • Added the new page to the English documentation navigation.

Add a public page documenting Codex session capture: what the collector
picks up from local OpenAI Codex sessions (CLI, IDE, desktop app), how to
turn it on with an events:add API key, and where captured sessions show up.
Registered in the en "SDK and CLI" nav group. Value/contract level only —
no implementation detail.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NoGWkrsoApuK4RvBmokbM7
@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 95aef79f-d858-4876-b480-9dd05ee65b7d

📥 Commits

Reviewing files that changed from the base of the PR and between 5095b90 and ceda9aa.

📒 Files selected for processing (1)
  • CHANGELOG.md

📝 Walkthrough

Walkthrough

Adds AgentEye documentation for opt-in Codex session capture, including supported sources, setup, backfill and streaming behavior, privacy requirements, navigation registration, and changelog coverage.

Changes

Codex session capture documentation

Layer / File(s) Summary
Capture behavior, setup, and release documentation
docs/agenteye/codex-capture.mdx, docs/docs.json, CHANGELOG.md
Documents local Codex transcript capture, installation and health checks, backfill and streaming behavior, destinations, privacy constraints, adds the page to English navigation, and records the documentation update in the changelog.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested labels: enhancement

Suggested reviewers: chhhee10

Poem

I’m a rabbit with transcripts tucked neat,
Watching Codex turns hop into a fleet.
Backfill once, then stream along,
Read-only trails where events belong.
Privacy guards my carrot patch—
AgentEye captures each dispatch!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise, specific, and accurately describes the main change.
Description check ✅ Passed The description covers purpose, scope, audience, and validation, though the template’s change-type and checklist sections are not filled out.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot added the enhancement New feature or request label Jul 24, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/agenteye/codex-capture.mdx`:
- Around line 31-32: Update the curl installation command in the Codex capture
documentation to use a shell-safe API-key placeholder without angle brackets,
and explicitly instruct readers to replace that placeholder with their actual
API key before running the command.
- Around line 31-32: Update the installer command in the Codex capture
documentation to fetch an immutable release tag or commit instead of the mutable
main branch. Preferably add checksum or signature verification before piping the
installer to sh, while preserving the existing API key and --codex-enabled
arguments.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: f443ec76-10a6-4d42-91e4-f02338941823

📥 Commits

Reviewing files that changed from the base of the PR and between 13955a2 and 5095b90.

📒 Files selected for processing (2)
  • docs/agenteye/codex-capture.mdx
  • docs/docs.json

Comment thread docs/agenteye/codex-capture.mdx
@NiveditJain
NiveditJain merged commit 2847466 into main Jul 24, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants