mirror of
https://github.com/morluto/rea
synced 2026-10-27 22:45:19 -04:00
morluto
08561e0eb7
* feat(clients): register Grok Build and Grok Bot during setup Detect both clients and install the local REA MCP registration the same way setup already handles the other agents. Grok Build edits only the REA tables in its TOML config and sets startup_timeout_sec to 30. Grok Bot writes the mcpServers.rea entry into mcp.json. That file is the registration to add to the signed-in account; setup does not call the account API. Filed by Grok. * fix(clients): clear a disabled Grok Build registration during setup Grok Build keeps a server suppressed when its name stays in disabled_mcp_servers, and setup was treating that file as already aligned. Setup now removes only that name, doctor reports the registration stale until it is gone, and uninstall keeps comments in an inline table whose only server was REA. Split the lifecycle suite and reflow the get-started page so static checks pass. * fix(verify): check packed Hopper search as literal-only The package verifier still called a regex probe that main deleted. The native bridge refuses regex and joins string hits with typed records, so the restored probe stubs that inventory and the check asserts the literal matches and the regex refusal. The new README translations also name Grok Build and Grok Bot. * fix(clients): stop treating a Grok Bot data directory as registered Grok Bot stores connectors in the signed-in account and runs them on its hosted computer. Setup no longer writes mcp.json or reports that file as aligned. Doctor and setup tell the caller to add the server from the Grok Bot chat. * fix(clients): drop multiline Grok disable-list entries Decode disabled_mcp_servers strings with the document parser so a multiline basic or literal string that loads as rea is removed. --------- Co-authored-by: Grok <eugene.ray@gmail.com> Co-authored-by: Cursor Agent <cursoragent@cursor.com> Co-authored-by: morluto <morluto@users.noreply.github.com>
431 lines
18 KiB
HTML
431 lines
18 KiB
HTML
<!doctype html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
<title>Get started — REA</title>
|
||
<meta
|
||
name="description"
|
||
content="Connect REA to your coding agent or inspect a local JavaScript or Electron app from the terminal. Setup, first questions and native provider guides."
|
||
/>
|
||
<meta name="theme-color" content="#ffffff" />
|
||
<link rel="icon" href="../assets/favicon.svg" type="image/svg+xml" />
|
||
<link rel="stylesheet" href="../assets/styles.css" />
|
||
<script src="../assets/main.js" defer></script>
|
||
</head>
|
||
<body id="top">
|
||
<a class="skip-link" href="#main">Skip to content</a>
|
||
<header class="site-header">
|
||
<div class="container header-inner">
|
||
<a class="brand" href="../" aria-label="REA home"
|
||
><span class="brand-name">REA</span
|
||
><span class="brand-caption">Reverse Engineer Anything</span></a
|
||
>
|
||
<nav class="navigation" aria-label="Main navigation">
|
||
<a href="../showcase/">Showcases</a
|
||
><a class="nav-start" href="./" aria-current="page">Get started</a
|
||
><a href="../guides/">Guides</a><a href="../faq/">FAQ</a>
|
||
</nav>
|
||
<a
|
||
class="nav-github"
|
||
href="https://github.com/morluto/rea"
|
||
aria-label="REA on GitHub"
|
||
title="REA on GitHub"
|
||
>
|
||
<svg
|
||
width="22"
|
||
height="22"
|
||
viewBox="0 0 16 16"
|
||
aria-hidden="true"
|
||
focusable="false"
|
||
>
|
||
<path
|
||
fill="currentColor"
|
||
d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82a7.65 7.65 0 0 1 2-.27c.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.01 8.01 0 0 0 16 8c0-4.42-3.58-8-8-8Z"
|
||
/>
|
||
</svg>
|
||
<span class="nav-github-count" hidden aria-hidden="true"></span>
|
||
</a>
|
||
</div>
|
||
</header>
|
||
<main id="main" class="container">
|
||
<div class="page-heading">
|
||
<p class="breadcrumb"><a href="../">Home</a> / Get started</p>
|
||
<h1>Set up REA.</h1>
|
||
<p class="lede">
|
||
Connect REA to your coding agent, or inspect a local app from your
|
||
terminal.
|
||
</p>
|
||
<p class="requirements">
|
||
You'll need Node.js 22 (22.19+), 24 (24.11+) or 26+, and npm.
|
||
</p>
|
||
</div>
|
||
<div class="article-layout">
|
||
<nav class="contents" aria-label="On this page">
|
||
<p>Setup options</p>
|
||
<ul>
|
||
<li><a href="#agent">Connect your coding agent</a></li>
|
||
<li><a href="#terminal">Use the CLI</a></li>
|
||
<li><a href="#native">Set up native analysis</a></li>
|
||
<li><a href="#help">Getting help</a></li>
|
||
</ul>
|
||
</nav>
|
||
<article class="article" aria-label="REA getting started guide">
|
||
<section class="article-section" id="agent">
|
||
<h2>Connect your coding agent</h2>
|
||
<p>
|
||
Run setup to connect REA to your coding agent. Client choices
|
||
include Claude Code, Codex, Cursor, Gemini CLI, Windsurf, Grok
|
||
Build, and other supported MCP clients. Grok Bot's connector is
|
||
added from its chat.
|
||
</p>
|
||
<div class="agent-terminal">
|
||
<div class="terminal-header">
|
||
<span class="terminal-title"
|
||
><span class="terminal-dots" aria-hidden="true"
|
||
><i></i><i></i><i></i></span
|
||
>Your coding agent</span
|
||
>
|
||
<button
|
||
class="copy-button"
|
||
type="button"
|
||
data-copy="agent-install-prompt"
|
||
aria-label="Copy REA installation prompt"
|
||
>
|
||
Copy
|
||
</button>
|
||
</div>
|
||
<p class="terminal-prompt">
|
||
<span class="prompt-symbol" aria-hidden="true">›</span
|
||
><span id="agent-install-prompt"
|
||
>Install REA and connect it to this coding agent using npx
|
||
rea-agents@latest setup. Show me the setup plan for approval,
|
||
then verify the installation.</span
|
||
><span class="terminal-cursor" aria-hidden="true"></span>
|
||
</p>
|
||
</div>
|
||
<details class="evidence-details">
|
||
<summary>Or run setup yourself</summary>
|
||
<div class="code-block">
|
||
<div class="code-header">
|
||
<span>Terminal</span
|
||
><button
|
||
class="copy-button"
|
||
type="button"
|
||
data-copy="agent-setup"
|
||
aria-label="Copy agent setup command"
|
||
>
|
||
Copy
|
||
</button>
|
||
</div>
|
||
<pre><code id="agent-setup">npx rea-agents@latest setup</code></pre>
|
||
</div>
|
||
</details>
|
||
<p>
|
||
Choose your client and review the setup plan. REA adds its MCP
|
||
connection and the matching investigation skill, keeping a backup
|
||
of existing configuration. It asks before applying the changes.
|
||
</p>
|
||
<p>
|
||
Restart your client when setup finishes. Give your agent a target
|
||
path and a specific question. For a JavaScript or Electron app,
|
||
you might start with:
|
||
</p>
|
||
<blockquote class="prompt">
|
||
<p>
|
||
Look at <code>/absolute/path/to/app</code> and find how it
|
||
exports data. Show the entry points, calls and dependencies
|
||
involved, with the source locations for your findings.
|
||
</p>
|
||
</blockquote>
|
||
<p>Replace the path with your local target.</p>
|
||
</section>
|
||
|
||
<section class="article-section" id="terminal">
|
||
<h2>Use the CLI</h2>
|
||
<p>
|
||
Analyze a JavaScript or Electron application folder or ASAR
|
||
archive without running the app:
|
||
</p>
|
||
<div class="code-block">
|
||
<div class="code-header">
|
||
<span>Static application analysis</span
|
||
><button
|
||
class="copy-button"
|
||
type="button"
|
||
data-copy="terminal-analysis"
|
||
aria-label="Copy JavaScript analysis command"
|
||
>
|
||
Copy
|
||
</button>
|
||
</div>
|
||
<pre><code id="terminal-analysis">npx -y rea-agents@latest analyze-javascript-application \
|
||
/absolute/path/to/app --json</code></pre>
|
||
</div>
|
||
<p>
|
||
Replace the path with your extracted app directory or
|
||
<code>.asar</code> file. On Windows, a path such as
|
||
<code>"D:/apps/example"</code> works here.
|
||
</p>
|
||
<p>
|
||
The result identifies the app, shows connections between modules
|
||
and gives their source locations. Connections REA cannot resolve
|
||
are marked in the result.
|
||
</p>
|
||
<p>
|
||
If you'd like a permanent <code>rea</code> command in your shell:
|
||
</p>
|
||
<div class="code-block">
|
||
<div class="code-header">
|
||
<span>Install the CLI</span
|
||
><button
|
||
class="copy-button"
|
||
type="button"
|
||
data-copy="install-cli"
|
||
aria-label="Copy CLI installation command"
|
||
>
|
||
Copy
|
||
</button>
|
||
</div>
|
||
<pre><code id="install-cli">npm install --global rea-agents</code></pre>
|
||
</div>
|
||
<p>
|
||
<a href="../guides/javascript/"
|
||
>Continue with the JavaScript application guide</a
|
||
>
|
||
</p>
|
||
</section>
|
||
|
||
<section class="article-section" id="native">
|
||
<h2>Set up native analysis</h2>
|
||
<p>
|
||
Native binaries need a local analysis tool. Choose and configure
|
||
one below, then give REA your executable or library.
|
||
</p>
|
||
<details class="evidence-details">
|
||
<summary>Choose a tool: Ghidra, Hopper or IDA</summary>
|
||
<div class="provider-list">
|
||
<div class="provider">
|
||
<h3>Ghidra</h3>
|
||
<div>
|
||
<p>
|
||
Use an existing Ghidra 12.1.x installation and a 64-bit
|
||
JDK 21 or newer on Linux x64 or macOS x64/arm64. Set the
|
||
paths before running setup:
|
||
</p>
|
||
<details class="evidence-details">
|
||
<summary>Connect your Ghidra installation</summary>
|
||
<div class="code-block">
|
||
<div class="code-header">
|
||
<span>Ghidra connection · macOS / Linux</span
|
||
><button
|
||
class="copy-button"
|
||
type="button"
|
||
data-copy="ghidra-connect"
|
||
aria-label="Copy ghidra connection · macos / linux"
|
||
>
|
||
Copy
|
||
</button>
|
||
</div>
|
||
<pre><code id="ghidra-connect">export GHIDRA_INSTALL_DIR=/absolute/path/to/ghidra_12.1.4_PUBLIC
|
||
export JAVA_HOME=/absolute/path/to/jdk-21
|
||
npx -y rea-agents@latest doctor --provider ghidra --json
|
||
npx rea-agents@latest setup</code></pre>
|
||
</div>
|
||
<p>
|
||
Replace both paths with your existing installations.
|
||
Setup checks them and records valid settings for your
|
||
selected client. On macOS, use a Ghidra package with the
|
||
native decompiler matching your host architecture.
|
||
</p>
|
||
</details>
|
||
</div>
|
||
</div>
|
||
<div class="provider">
|
||
<h3>Hopper</h3>
|
||
<div>
|
||
<p>
|
||
Connect Hopper on macOS or Linux. Run the setup command
|
||
above; it detects an existing installation or offers an
|
||
installation plan for your approval.
|
||
</p>
|
||
<p>
|
||
On macOS, complete Hopper's first-run choice of demo mode
|
||
or license activation before an unattended analysis.
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<div class="provider">
|
||
<h3>IDA</h3>
|
||
<div>
|
||
<p>
|
||
The verified IDA setups use Windows, with an existing MCP
|
||
registration for an attached GUI or a headless database.
|
||
Linux and macOS headless analysis remains unverified.
|
||
</p>
|
||
<details class="evidence-details">
|
||
<summary>
|
||
Connect an existing IDA MCP registration
|
||
</summary>
|
||
<p>
|
||
Keep the upstream server's working <code>command</code>,
|
||
<code>args</code> and optional <code>env</code> in a
|
||
JSON file. An existing <code>mcpServers</code> object
|
||
with an <code>ida-pro-mcp</code> entry is also accepted.
|
||
Point REA at that file before setup:
|
||
</p>
|
||
<div class="code-block">
|
||
<div class="code-header">
|
||
<span>IDA connection · Windows PowerShell</span
|
||
><button
|
||
class="copy-button"
|
||
type="button"
|
||
data-copy="ida-connect"
|
||
aria-label="Copy IDA connection for Windows PowerShell"
|
||
>
|
||
Copy
|
||
</button>
|
||
</div>
|
||
<pre><code id="ida-connect">$env:REA_IDA_MCP_CONFIG = "C:/analysis/ida-mcp.json"
|
||
$env:REA_ANALYSIS_PROVIDER = "ida"
|
||
npx -y rea-agents@latest doctor --provider ida --json
|
||
npx rea-agents@latest setup</code></pre>
|
||
</div>
|
||
<p>
|
||
The attached profile uses upstream legacy 1.4.0 tools
|
||
with the original binary already open in IDA. The
|
||
headless profile uses the upstream database-supervisor
|
||
API and a registration with
|
||
<code>"mode": "headless"</code>; real verification
|
||
covers an IDA 9.3 Windows x64 supervisor. Doctor checks
|
||
the registration without starting IDA.
|
||
</p>
|
||
<p>
|
||
Give REA the original executable path, with
|
||
<code>--provider ida</code> in a CLI query. For an
|
||
agent, include <code>REA_IDA_MCP_CONFIG</code> in the
|
||
REA registration's environment and select IDA when
|
||
opening the binary.
|
||
</p>
|
||
</details>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</details>
|
||
<p class="small-heading">
|
||
For an existing Ghidra setup, inspect a function with:
|
||
</p>
|
||
<div class="code-block">
|
||
<div class="code-header">
|
||
<span>Function analysis</span
|
||
><button
|
||
class="copy-button"
|
||
type="button"
|
||
data-copy="native-function"
|
||
aria-label="Copy native function analysis command"
|
||
>
|
||
Copy
|
||
</button>
|
||
</div>
|
||
<pre><code id="native-function">npx -y rea-agents@latest function /absolute/path/to/program main \
|
||
--provider ghidra --json</code></pre>
|
||
</div>
|
||
<p>
|
||
Replace <code>main</code> with the function name or address you
|
||
want to inspect.
|
||
</p>
|
||
<details class="evidence-details">
|
||
<summary>How native analysis sessions work</summary>
|
||
<p>
|
||
Each CLI command imports and analyzes the binary, then closes
|
||
its session. Your agent's MCP queries reuse the imported binary
|
||
while that session is open.
|
||
</p>
|
||
</details>
|
||
<p>
|
||
<a href="../guides/native/">Follow a native analysis example</a>
|
||
to see how the function result leads to a recovered calculation.
|
||
</p>
|
||
</section>
|
||
|
||
<section class="article-section" id="help">
|
||
<h2>Getting help</h2>
|
||
<h3>If your agent doesn't see REA</h3>
|
||
<p>
|
||
Restart or reconnect the client after setup. Check its REA
|
||
connection with <code>doctor</code>; for Codex:
|
||
</p>
|
||
<div class="code-block">
|
||
<div class="code-header">
|
||
<span>Check one client</span
|
||
><button
|
||
class="copy-button"
|
||
type="button"
|
||
data-copy="client-doctor"
|
||
aria-label="Copy client diagnosis command"
|
||
>
|
||
Copy
|
||
</button>
|
||
</div>
|
||
<pre><code id="client-doctor">npx -y rea-agents@latest doctor --client codex --json</code></pre>
|
||
</div>
|
||
<h3 class="small-heading">If a provider needs attention</h3>
|
||
<p>Check the provider you're using. For Ghidra:</p>
|
||
<div class="code-block">
|
||
<div class="code-header">
|
||
<span>Check one provider</span
|
||
><button
|
||
class="copy-button"
|
||
type="button"
|
||
data-copy="provider-doctor"
|
||
aria-label="Copy provider diagnosis command"
|
||
>
|
||
Copy
|
||
</button>
|
||
</div>
|
||
<pre><code id="provider-doctor">npx -y rea-agents@latest doctor --provider ghidra --json</code></pre>
|
||
</div>
|
||
<p>The report gives the failed check and a suggested next step.</p>
|
||
<ul class="reading-list">
|
||
<li>
|
||
<a href="../faq/">REA FAQ</a
|
||
><span>Quick answers on updates, agents and analysis.</span>
|
||
</li>
|
||
<li>
|
||
<a href="../guides/">Choose an investigation guide</a
|
||
><span
|
||
>Worked examples for a binary, an Electron app and a
|
||
browser.</span
|
||
>
|
||
</li>
|
||
<li>
|
||
<a href="https://github.com/morluto/rea/issues">GitHub issues</a
|
||
><span>Report a problem with the command and diagnostics.</span>
|
||
</li>
|
||
<li>
|
||
<a href="https://discord.gg/GkcryMnJDM">REA community</a
|
||
><span>Questions, investigations and work in progress.</span>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
</article>
|
||
</div>
|
||
</main>
|
||
<footer class="site-footer">
|
||
<div class="container footer-inner">
|
||
<p>REA · Reverse Engineer Anything</p>
|
||
<div class="footer-links">
|
||
<a href="https://github.com/morluto/rea">Source</a
|
||
><a href="https://github.com/morluto/rea/blob/main/LICENSE"
|
||
>MIT license</a
|
||
><a href="https://discord.gg/GkcryMnJDM">Community</a>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
<p class="sr-only" id="copy-status" role="status" aria-live="polite"></p>
|
||
<a class="back-to-top" href="#top" aria-label="Back to top">
|
||
<span aria-hidden="true">↑</span> Top
|
||
</a>
|
||
</body>
|
||
</html>
|