docs(agenteye): add Codex session capture page#592
Conversation
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
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds AgentEye documentation for opt-in Codex session capture, including supported sources, setup, backfill and streaming behavior, privacy requirements, navigation registration, and changelog coverage. ChangesCodex session capture documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested labels: Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
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. Comment |
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NoGWkrsoApuK4RvBmokbM7
There was a problem hiding this comment.
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
📒 Files selected for processing (2)
docs/agenteye/codex-capture.mdxdocs/docs.json
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 enSDK and CLInav group (alongside the Python SDK). It covers:events:addAPI key and--codex-enabled, then verify withhealth.events:add.Audience / confidentiality
Written for the public reader (evaluating the product): value and the public CLI contract only — install command, flags,
events:addpermission 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:mdx→ 676 pages parsed cleanly (incl. the new page).docs.jsonparses; 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 validateruns in this repo'sdocsCI job (its local puppeteer/chrome step isn't available in my sandbox).Translations are intentionally omitted —
translate-docs.ymlgenerates the 14 locales and their nav entries on its next run.Summary by CodeRabbit