Files
rea/website/public/get-started/index.html
T
ysopwnableandGitHub 4e3953cc45 feat(website): introduce REA and the DX-Ball reconstruction (#906)
* feat(website): add local introduction and DX-Ball showcase

* feat(website): illustrate REA and DX-Ball reconstruction

Add two explanatory figures and an interactive comparison of recorded DX-Ball x86 instructions with maintained C. Preserve the full instruction listing, caller excerpt, constant reads, figure prompts and evidence provenance.

Validation: Chrome preview at local root and /rea/; five comparison steps; 22 clipboard checks; keyboard navigation; responsive widths 1440, 768, 390 and 320. Verify assembly against saved REA Evidence and C against the pinned public source. Existing execution and compiler results are cited, not rerun.

* docs(website): show the REA queries behind source recovery

Present compact function, caller and byte-read request excerpts alongside recorded evidence. Keep the overview and case narrative focused on REA, with provider provenance in contributor notes. Replace raster references with maintained SVG source diagrams while retaining the established layout and image-generation prompts.

Validation: local and /rea/ Chrome previews, five comparison steps, 22 clipboard checks, responsive widths and keyboard navigation passed. SVG XML and all 41 local links/assets passed checks.
2026-10-07 17:11:06 +08:00

311 lines
12 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>
<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/dx-ball/">DX-Ball</a
><a class="nav-start" href="./" aria-current="page">Get started</a
><a href="https://github.com/morluto/rea/tree/main/docs">Docs</a
><a href="https://github.com/morluto/rea">GitHub</a>
</nav>
</div>
</header>
<main id="main" class="container">
<div class="page-heading">
<p class="breadcrumb"><a href="../">Home</a> / Get started</p>
<h1>Start with a question.</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.
<a
href="https://github.com/morluto/rea/blob/main/docs/installation.md"
>Full installation guide</a
>
</p>
</div>
<div class="article-layout">
<nav class="contents" aria-label="On this page">
<p>Choose your starting point</p>
<ul>
<li><a href="#agent">With your agent</a></li>
<li><a href="#terminal">From the terminal</a></li>
<li><a href="#native">Native binaries</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>With your agent</h2>
<p>
Run setup to connect REA to Claude Code, Codex, Cursor or another
<a
href="https://github.com/morluto/rea/blob/main/docs/installation.md#supported-agents"
>supported client</a
>.
</p>
<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>
<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. Read the findings, then
ask a narrower follow-up about a function or connection you want
to understand.
</p>
</section>
<section class="article-section" id="terminal">
<h2>From the terminal</h2>
<p>
You can start with a JavaScript or Electron application folder or
ASAR archive. This path uses Node.js and npm and reads the app
without running it.
</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 includes the application's identity, recovered module
relationships and evidence locations. It also records
relationships that remain unresolved. Use those findings to choose
where to investigate next.
</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="https://github.com/morluto/rea/blob/main/docs/javascript-application-workflows.md"
>Continue with the JavaScript application guide</a
>
</p>
</section>
<section class="article-section" id="native">
<h2>Working with native binaries</h2>
<p>
Choose a deep-analysis provider for your target and host. If you
already use one of these tools, start with its connection guide.
</p>
<div class="provider-list">
<div class="provider">
<h3>Ghidra</h3>
<div>
<p>
Use an existing Ghidra installation and JDK. Setup checks
their paths and records them for your selected clients.
</p>
<a
href="https://github.com/morluto/rea/blob/main/docs/installation.md#ghidra"
>Ghidra setup and supported hosts</a
>
</div>
</div>
<div class="provider">
<h3>Hopper</h3>
<div>
<p>
Connect Hopper on macOS or Linux. Setup can also install it
after you review and approve the installation plan.
</p>
<a
href="https://github.com/morluto/rea/blob/main/docs/installation.md#hopper"
>Hopper installation</a
>
</div>
</div>
<div class="provider">
<h3>IDA</h3>
<div>
<p>
Reuse an existing IDA MCP registration for read-only
analysis through an attached GUI or headless database.
</p>
<a
href="https://github.com/morluto/rea/blob/main/docs/ida-provider.md"
>IDA connection guide</a
>
</div>
</div>
</div>
<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">rea 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. The first query imports and analyzes the target,
so it can take longer than later requests.
</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. To check its
registration, use a client-scoped report; 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="https://github.com/morluto/rea/blob/main/docs/installation.md"
>Installation and troubleshooting</a
><span
>Client configuration, versions and provider
requirements.</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>
</body>
</html>