Skip to content

docs(agenteye): explain device login approval - #626

Open
SiddarthAA wants to merge 3 commits into
mainfrom
docs/agenteye-device-approval
Open

docs(agenteye): explain device login approval#626
SiddarthAA wants to merge 3 commits into
mainfrom
docs/agenteye-device-approval

Conversation

@SiddarthAA

@SiddarthAA SiddarthAA commented Jul 30, 2026

Copy link
Copy Markdown
Member

Documents the user-visible AgentEye CLI device-login flow and its approval boundary: the human signs in with the matching email, verifies the short code, reviews scopes, and approves; possessing the link alone cannot authorize a device.

Summary by CodeRabbit

  • Documentation
    • Added guidance for approving AgentEye CLI logins from another device.
    • Documented the device-login flow, including approval links, matching-email sign-in, short-code verification, scoped approval, and session claiming.
    • Clarified that sharing an approval link alone cannot authorize a device.
    • Added documentation for Claude Code session capture, including what’s ingested, UI locations, setup, backfill behavior, and privacy notes.
    • Updated capture docs to align Hermes, Codex, and OpenClaw collector wording and scope (single collector capturing multiple agents on the same machine).
    • Updated documentation navigation to include the Claude Code capture page.

@coderabbitai

coderabbitai Bot commented Jul 30, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Documents AgentEye device-login approval and Claude Code session capture, including setup, supported capture paths, child sessions, backfill behavior, UI visibility, privacy boundaries, navigation, cross-references, and changelog entries.

Changes

Agent Observability Documentation

Layer / File(s) Summary
Document device-login approval
docs/agenteye/cli-and-agents.mdx
Adds CLI and browser instructions for approving a device login, including matching-email requirements and session claiming with --wait.
Document Claude Code capture
docs/agenteye/claude-capture.mdx, docs/docs.json
Adds Claude Code capture documentation covering supported integrations, event scope, child sessions, setup, backfill, UI access, and unredacted content handling, then adds the page to English navigation.
Align capture documentation and release notes
docs/agenteye/codex-capture.mdx, docs/agenteye/hermes-capture.mdx, docs/agenteye/openclaw-capture.mdx, CHANGELOG.md
Updates related capture-page references and records the device-login and Claude Code documentation changes in the changelog.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

Suggested labels: enhancement

Suggested reviewers: niveditjain

Poem

A rabbit hops through docs so bright,
Guiding device logins through the night.
Claude’s sessions now leave a trace,
With child streams in their proper place.
Cross-links bloom and menus gleam—
A tidy trail for every team.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is only a one-line summary and omits the required template sections and checklist. Add the required ## Description, ## Type of Change, and ## Checklist sections, and fill out the checklist items or mark them appropriately.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the device-login approval docs update, which is a main part of the PR.
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.

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

docs/agenteye/claude-capture.mdx

ESLint skipped: missing config or dependency (missing-dependency). The ESLint configuration references a package that is not available in the sandbox.

docs/agenteye/codex-capture.mdx

ESLint skipped: the ESLint configuration for this file references a package that is not available in the sandbox.

docs/agenteye/hermes-capture.mdx

ESLint skipped: the ESLint configuration for this file references a package that is not available in the sandbox.

  • 1 others

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 30, 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/claude-capture.mdx`:
- Around line 31-33: Update the primary setup command in the Claude capture
documentation to download and verify a pinned installer release using its
checksum rather than executing mutable main content. Replace the `--key` argv
credential flow with a non-argv secret input mechanism, while preserving the
existing `--claude-enabled` setup behavior.
- Line 18: Update the documentation statement near the failed-turn and
tool-failure description to qualify Claude Code reasoning capture by the
supported version or explicitly distinguish excluded reasoning-content from any
reasoning metadata retained in local transcripts. Avoid the current absolute
claim that Claude Code reasoning text is never captured.
🪄 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: a1f2f2fe-9799-4bf2-b4f3-98605f315c3f

📥 Commits

Reviewing files that changed from the base of the PR and between b0965dc and cb5929f.

📒 Files selected for processing (6)
  • CHANGELOG.md
  • docs/agenteye/claude-capture.mdx
  • docs/agenteye/codex-capture.mdx
  • docs/agenteye/hermes-capture.mdx
  • docs/agenteye/openclaw-capture.mdx
  • docs/docs.json
🚧 Files skipped from review as they are similar to previous changes (1)
  • CHANGELOG.md


Each Claude Code session becomes an AgentEye [session](/agenteye/sessions). Its user and assistant turns, tool calls and results, token usage and context fill, hook runs, compaction boundaries, and failures become the matching [events](/agenteye/event-stream).

This includes failed turns, API errors, and tool failures, so sessions remain useful when you are investigating what went wrong. Claude Code's reasoning text is not captured because its local transcripts do not contain that content.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔒 Security & Privacy | 🟠 Major | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "## changed file excerpt"
if [ -f docs/agenteye/claude-capture.mdx ]; then
  nl -ba docs/agenteye/claude-capture.mdx | sed -n '1,80p'
else
  echo "docs/agenteye/claude-capture.mdx not found"
fi

echo
echo "## repository references to Claude Code reasoning/capture/transcript"
rg -n -i "claude-code|claude code|reasoning|transcript|capture" docs/agenteye/claude-capture.mdx . 2>/dev/null | head -n 160 || true

Repository: FailproofAI/failproofai

Length of output: 225


🌐 Web query:

Claude Code release notes reasoning-effort metadata session transcripts feed.xml anthropics/claude-code

💡 Result:

As of July 30, 2026, there is no official implementation or release note confirming that "reasoning-effort" metadata has been added to the status line JSON or session transcripts in Claude Code. Multiple community members have filed feature requests (e.g., issues #13158, #37701, #38637, #50060) on the official anthropics/claude-code GitHub repository explicitly asking for the current reasoning effort level (e.g., low, medium, high) to be exposed in the status line stdin JSON. Users report that this metadata is currently missing from the status line hook, making it difficult to display real-time, mid-session changes made via the /effort command or other settings [1][2][3][4][5]. Currently, while Claude Code internally tracks reasoning effort, it is not consistently exposed in an accessible, programmatic way for external status line scripts or within standard transcript files [1][2][4]. Users relying on workarounds, such as parsing local configuration files (like settings.json) or attempting to regex-match transcript output, find these methods fragile because they do not reliably reflect dynamic, in-session state changes [2][3][4]. You can monitor the official GitHub repository for updates and progress on these feature requests [1][4]. The official documentation, including the changelog, remains the primary source for confirming when such metadata is officially supported [6][7].

Citations:


🌐 Web query:

site:github.com/anthropics/claude-code reasoning effort session transcripts feed.xml "reasoning effort"

💡 Result:

Reasoning effort in Claude Code refers to the configurable "thinking" budget assigned to the model during complex tasks, which directly impacts response latency, cost, and depth of reasoning [1]. Recent updates to Claude Code have integrated reasoning effort more deeply into the system: 1. Session Transcripts: Reasoning effort levels are now recorded on each assistant message within session transcripts [2][3]. This change ensures that the effort applied to specific turns is documented, which is particularly useful for tracking model behavior and debugging [4]. 2. Status Line Integration: The statusLine stdin JSON payload now includes an effort.level field [5]. This allows custom status line scripts to display the active reasoning effort level in real-time, including changes made mid-session via the /effort command [1][5]. 3. Configuration and Precedence: Reasoning effort can be set or overridden through multiple layers. While documentation indicates a precedence of environment variables > skill/subagent frontmatter > session settings > model defaults, users have noted discrepancies where certain overrides (such as skill-specific frontmatter) may not always take effect at runtime [6][7]. 4. Feed Updates: Technical changes related to these features are tracked in the project's feed (feed.xml) and changelog, which document updates such as the inclusion of reasoning effort in status line payloads and transcript records [2][3]. Important limitations identified by users include the failure of the --resume command to persist the session's effort level, which can lead to unexpected behavior and prompt cache invalidation [4], as well as issues where environment-forced effort levels may bypass model capability checks and cause errors with subagents that do not support reasoning parameters [8].

Citations:


Make the reasoning-data claim version-specific.

Claude Code release notes document that reasoning effort is recorded in session transcripts, so “Claude Code’s reasoning text is not captured” is absolute enough that users may infer transcripts remain private from Claude’s own reasoning data. Clarify that the collector excludes Claude reasoning-content while noting any reasoning metadata that may still remain, or tie the statement to the supported Claude Code version.

🤖 Prompt for 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.

In `@docs/agenteye/claude-capture.mdx` at line 18, Update the documentation
statement near the failed-turn and tool-failure description to qualify Claude
Code reasoning capture by the supported version or explicitly distinguish
excluded reasoning-content from any reasoning metadata retained in local
transcripts. Avoid the current absolute claim that Claude Code reasoning text is
never captured.

Source: MCP tools

Comment on lines +31 to +33
curl -fsSL https://raw.githubusercontent.com/FailproofAI/agenteye-collector/main/install.sh \
| sh -s -- --key <YOUR_API_KEY> --claude-enabled
```

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔒 Security & Privacy | 🟠 Major | 🏗️ Heavy lift

Avoid an unpinned installer and API key in argv.

This primary setup path executes mutable main content via curl | sh, while --key <YOUR_API_KEY> exposes the credential through shell history and process arguments. Use a pinned release/checksum and a non-argv secret input path before publishing this command.

🤖 Prompt for 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.

In `@docs/agenteye/claude-capture.mdx` around lines 31 - 33, Update the primary
setup command in the Claude capture documentation to download and verify a
pinned installer release using its checksum rather than executing mutable main
content. Replace the `--key` argv credential flow with a non-argv secret input
mechanism, while preserving the existing `--claude-enabled` setup behavior.

@hermes-exosphere hermes-exosphere left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Review summary

Changes requested — the new setup instructions introduce an unsafe install and credential-handling pattern. The page otherwise reads clearly: device-login guidance is precise, navigation and cross-links are wired correctly, and the capture scope/privacy boundary is useful.

Verification

  • bun run validate:mdx — passed (721 pages)
  • Checked changed local AgentEye links — all resolve
  • Confirmed --claude-enabled is supported by the collector installer
  • All PR CI checks are passing

Please address the inline security concern before merging.

Capture is off until you enable it. Install the collector with an API key that has the `events:add` permission (see [API keys](/agenteye/api-keys)), and turn on Claude Code capture:

```bash
curl -fsSL https://raw.githubusercontent.com/FailproofAI/agenteye-collector/main/install.sh \

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Blocking — unsafe installer and exposed API key. This executes mutable main content immediately and passes the events:add key as a command-line argument, where it can be exposed to other local processes or shell history. Publish a version-pinned installer/binary with an integrity check, and use a non-argv secret input (for example, a protected environment variable or stdin) before making this the recommended setup path.

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