[GH-ISSUE #1353] [Docs] README: FAQ setup command, IDA in the intro, Node badge #474

Closed
opened 2026-10-15 18:25:21 +00:00 by bsakaguchi · 2 comments
Owner

Originally created by @CassieFox23 on GitHub (Oct 9, 2026).
Original GitHub issue: https://github.com/morluto/rea/issues/1353

TL;DR: A few small things I noticed reading the README. The skills FAQ says to run rea setup, but that only works after a global install. The intro forgets IDA. And the Node badge makes it look like more versions are supported than really are. Plus one table cell that could be clearer.

Before submitting

  • I searched the existing issues for a related documentation report.
  • I removed credentials, tokens, private paths, and sensitive target data.

Documentation location

README.md (English), main at 750fb6565. The rea setup FAQ line is also in all 16 translated READMEs; I didn't check the other items there.

Problem

  1. The skills FAQ points to rea setup. L248–249 say "Use rea setup to register REA's MCP server". The rea command is only on your PATH after the global install at L101 (npm install --global rea-agents). Someone who installed only the skill from skills.sh would get "command not found". Related: #737.
  2. The intro leaves out IDA. L55 says "Native analysis can use an existing Hopper or Ghidra installation". The table at L152 and the FAQ heading at L228 ("Do I need Hopper, Ghidra or IDA?") include IDA.
  3. The Node badge overstates support. The L14 badge reads "22.19+" and its alt text "Node.js 22+". L147 says "22.x (>=22.19), 24.x (>=24.11), or 26+", and package.json engines is ^22.19.0 || ^24.11.0 || >=26.0.0. So 23.x, 24.0–24.10 and 25.x look supported but aren't.
  4. Also, one table cell. The .NET row lists "Static inspection" as a requirement (L159).

Expected content

  1. L248: change rea setup to npx rea-agents setup, as in the quick start (L25, L66).
  2. L55: "…an existing Hopper, Ghidra or IDA installation…".
  3. Badge label and alt text such as "Node.js 22.19+ · 24.11+ · 26+", or point the badge link at #what-you-can-analyze.
  4. "None (static only)" for .NET.

Supporting evidence

Item 1: L101 and L248–249. Item 2: L152 and L228. Item 3: L14, L147 and package.json engines.

Additional context

The flow diagram and the showcase strip have white backgrounds, so on GitHub's dark theme they sit in bright boxes.

Thanks for the README.

I checked every line number and quote against README.md at 750fb6565.

🤖 Generated with Claude Code (Opus 5.5) 🦊

Originally created by @CassieFox23 on GitHub (Oct 9, 2026). Original GitHub issue: https://github.com/morluto/rea/issues/1353 **TL;DR:** A few small things I noticed reading the README. The skills FAQ says to run `rea setup`, but that only works after a global install. The intro forgets IDA. And the Node badge makes it look like more versions are supported than really are. Plus one table cell that could be clearer. ### Before submitting - [X] I searched the existing issues for a related documentation report. - [X] I removed credentials, tokens, private paths, and sensitive target data. ### Documentation location README.md (English), main at 750fb6565. The `rea setup` FAQ line is also in all 16 translated READMEs; I didn't check the other items there. ### Problem 1. **The skills FAQ points to `rea setup`.** L248–249 say "Use `rea setup` to register REA's MCP server". The `rea` command is only on your PATH after the global install at L101 (`npm install --global rea-agents`). Someone who installed only the skill from skills.sh would get "command not found". Related: #737. 2. **The intro leaves out IDA.** L55 says "Native analysis can use an existing Hopper or Ghidra installation". The table at L152 and the FAQ heading at L228 ("Do I need Hopper, Ghidra or IDA?") include IDA. 3. **The Node badge overstates support.** The L14 badge reads "22.19+" and its alt text "Node.js 22+". L147 says "22.x (>=22.19), 24.x (>=24.11), or 26+", and `package.json` engines is `^22.19.0 || ^24.11.0 || >=26.0.0`. So 23.x, 24.0–24.10 and 25.x look supported but aren't. 4. **Also, one table cell.** The .NET row lists "Static inspection" as a requirement (L159). ### Expected content 1. L248: change `rea setup` to `npx rea-agents setup`, as in the quick start (L25, L66). 2. L55: "…an existing Hopper, Ghidra or IDA installation…". 3. Badge label and alt text such as "Node.js 22.19+ · 24.11+ · 26+", or point the badge link at `#what-you-can-analyze`. 4. "None (static only)" for .NET. ### Supporting evidence Item 1: L101 and L248–249. Item 2: L152 and L228. Item 3: L14, L147 and `package.json` engines. ### Additional context The flow diagram and the showcase strip have white backgrounds, so on GitHub's dark theme they sit in bright boxes. Thanks for the README. I checked every line number and quote against README.md at 750fb6565. 🤖 Generated with Claude Code (Opus 5.5) 🦊
bsakaguchi 2026-10-15 18:25:21 +00:00
Author
Owner

@CassieFox23 commented on GitHub (Oct 9, 2026):

TL;DR: Thanks akram1089 for PR #1355! It covers all four points here. I left two small notes on the translations. I'll keep this open until the PR merges. The merge will close it on its own.

Edit: removed a user tag.

My notes are on the PR.

🤖 Generated with Claude Code (Opus 5.5) 🦊

<!-- gh-comment-id:6088351990 --> @CassieFox23 commented on GitHub (Oct 9, 2026): **TL;DR:** Thanks akram1089 for PR #1355! It covers all four points here. I left two small notes on the translations. I'll keep this open until the PR merges. The merge will close it on its own. Edit: removed a user tag. My notes are [on the PR](https://github.com/morluto/rea/pull/1355#issuecomment-6087950336). 🤖 Generated with Claude Code (Opus 5.5) 🦊
Author
Owner

@CassieFox23 commented on GitHub (Oct 9, 2026):

TL;DR: All four points are fixed on main now, so I'm closing this. The fix came in through 5b3715ef, not PR #1355.

I read main after that commit. The FAQ shows npx rea-agents@latest setup. IDA is in the intro. The Node badge is the new "requirements" one. The translations' badge links to #current-status, and that anchor exists in the German file I checked. Thanks to akram1089 for the PR, and to morluto for landing it on main.

🤖 Generated with Claude Code (Fable 5.1) 🦊

<!-- gh-comment-id:6090100105 --> @CassieFox23 commented on GitHub (Oct 9, 2026): **TL;DR:** All four points are fixed on main now, so I'm closing this. The fix came in through 5b3715ef, not PR #1355. I read main after that commit. The FAQ shows `npx rea-agents@latest setup`. IDA is in the intro. The Node badge is the new "requirements" one. The translations' badge links to `#current-status`, and that anchor exists in the German file I checked. Thanks to akram1089 for the PR, and to morluto for landing it on main. 🤖 Generated with Claude Code (Fable 5.1) 🦊
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
morluto/rea#474
No description provided.