From c048b853f8cc5a942c449923c962db7be1c4dc2d Mon Sep 17 00:00:00 2001 From: Kaoru0822 <208281322+kaoru0822-kitauji@users.noreply.github.com> Date: Sun, 11 Oct 2026 02:26:15 +0000 Subject: [PATCH] docs(website): make the analysis guides easier to start - Each guide opens with a short "Before you start" box: difficulty, what you need, a link to the step-by-step setup and a one-line explanation of Electron or native programs. - The browser guide gives commands to open Chrome on Mac and Windows Command Prompt, not only Linux, and its prompt includes the debugging address. - Multi-line terminal commands note that Windows Command Prompt needs them on one line without the backslashes. - The guide hub lists guides from easiest to hardest, with what each one needs. Co-Authored-By: Claude Opus 5.5 --- website/public/assets/styles.css | 26 +++++++ website/public/guides/browser/index.html | 77 ++++++++++++++++++--- website/public/guides/index.html | 52 ++++++++------ website/public/guides/javascript/index.html | 32 ++++++++- website/public/guides/native/index.html | 33 +++++++++ 5 files changed, 186 insertions(+), 34 deletions(-) diff --git a/website/public/assets/styles.css b/website/public/assets/styles.css index e0f57b412..84d7fdeb8 100644 --- a/website/public/assets/styles.css +++ b/website/public/assets/styles.css @@ -1443,6 +1443,32 @@ pre code { border-radius: 3px; color: #414b55; } +.guide-entry .guide-needs { + margin-bottom: 0.9rem; + color: var(--ink); + font-size: 0.9rem; +} +.before-start { + margin-bottom: 2.5rem; + padding: 1.2rem 1.4rem; + border: 1px solid #ced9e5; + border-left: 3px solid var(--accent); + border-radius: 5px; + background: #fafbfc; +} +.before-start-title { + margin-bottom: 0.6rem; + font-weight: 650; +} +.before-start ul { + margin: 0; +} +.before-start li + li { + margin-top: 0.45rem; +} +.before-start .caption { + margin: 0.8rem 0 0; +} .example-files { display: flex; flex-wrap: wrap; diff --git a/website/public/guides/browser/index.html b/website/public/guides/browser/index.html index 69d006205..85328f82a 100644 --- a/website/public/guides/browser/index.html +++ b/website/public/guides/browser/index.html @@ -157,6 +157,27 @@
+

What happens when you click Export?

@@ -207,16 +228,48 @@

Open Chrome with remote debugging

Open the hosted Notes example with a separate browser profile and - a local debugging port. On Linux: + a local debugging port. Copy the command for your computer into + the terminal and press Enter.

- Start the example browserStart the example browser · Mac +
+ 
open -na "Google Chrome" --args \
+  --remote-debugging-port=9222 \
+  --user-data-dir=/tmp/rea-notes-browser \
+  https://rea.tools/examples/notes-web/
+
+
+
+ Start the example browser · Windows Command Prompt +
+ 
start chrome --remote-debugging-port=9222 --user-data-dir="%TEMP%\rea-notes-browser" https://rea.tools/examples/notes-web/
+
+
+
+ Start the example browser · Linux @@ -227,9 +280,8 @@ https://rea.tools/examples/notes-web/

- Use your installed browser's executable path on macOS or Windows. - You can replace the page URL with another page you want to - inspect. + A new Chrome window opens on the Notes example. You can replace + the page URL with another page you want to inspect.

REA connects to this existing browser. You keep control of the @@ -256,15 +308,16 @@

Use REA to inspect this page while I click Export notes. What + >Use REA with the browser at http://127.0.0.1:9222 to inspect + the Notes example page while I click Export notes. What request does it make, and how is the CSV built?

- Example prompt. Give your agent the debugging endpoint, - http://127.0.0.1:9222, and the page URL. Let it start - the capture before you click. + Example prompt. http://127.0.0.1:9222 is the + debugging address from the command above. Keep that Chrome window + open, and let your agent start the capture before you click.

Your agent discovers the page target, starts an observation @@ -290,6 +343,10 @@ 

npx -y rea-agents@latest list-browser-targets \
   http://127.0.0.1:9222 --json
+

+ In Windows Command Prompt, put the command on one line and leave + out the \ characters. +

Choose the target with the Notes example URL. Replace TARGET_ID below with its ID, then run: diff --git a/website/public/guides/index.html b/website/public/guides/index.html index 2d57e000a..196a9e0e4 100644 --- a/website/public/guides/index.html +++ b/website/public/guides/index.html @@ -6,7 +6,7 @@ Reverse Engineering Guides — REA @@ -18,7 +18,7 @@ - + @@ -39,7 +39,7 @@ - + @@ -138,8 +138,8 @@

Home / Guides

REA guides.

- Analyze a native function, an Electron export or a browser request. - Each guide includes a prompt, code and results. + Follow an Electron export, observe a browser request or analyze a + native function. Each guide includes a prompt, code and results.

@@ -165,23 +165,6 @@

-
-

Native binaries

-
-

Recover a sound-pan calculation

-

- Start with a Windows game executable. Inspect instructions, follow - a caller, read numeric constants and check the recovered C. -

-
- Instructions - Caller - Constants - C function -
- Native analysis guide -
-

JavaScript & Electron

@@ -196,6 +179,9 @@ Preload API IPC CSV file
+

+ Good first guide. Needs only REA setup. +

JavaScript & Electron guide @@ -218,9 +204,31 @@ Captured request Export script +

Needs REA setup and Google Chrome.

Browser observation guide
+
+

Native binaries

+
+

Recover a sound-pan calculation

+

+ Start with a Windows game executable. Inspect instructions, follow + a caller, read numeric constants and check the recovered C. +

+
+ Instructions + Caller + Constants + C function +
+

+ Advanced. Needs REA setup and Ghidra, Hopper or + IDA. +

+ Native analysis guide +
+
diff --git a/website/public/guides/javascript/index.html b/website/public/guides/javascript/index.html index dd2d2a9c3..5247be835 100644 --- a/website/public/guides/javascript/index.html +++ b/website/public/guides/javascript/index.html @@ -157,6 +157,29 @@
+

Where does “Export notes” go?

@@ -236,8 +259,9 @@

- Example prompt. Include the absolute path to the application - folder or app.asar. + Example prompt. Add the full path to the application folder or + app.asar at the end; + here's how to copy a path.

REA reads the application files and builds a map of entrypoints, @@ -371,6 +395,10 @@ 

npx -y rea-agents@latest analyze-javascript-application \
   /absolute/path/to/notes-example --json
+

+ In Windows Command Prompt, put the command on one line and leave + out the \ characters. +

Replace the path with the folder you unzipped. You should find one IPC channel and one matching handler in diff --git a/website/public/guides/native/index.html b/website/public/guides/native/index.html index c92f7f98d..a61036619 100644 --- a/website/public/guides/native/index.html +++ b/website/public/guides/native/index.html @@ -156,6 +156,35 @@

+

Calculate left/right sound panning

@@ -343,6 +372,10 @@ return (DxBallInt)pan; 

npx -y rea-agents@latest function /absolute/path/to/program main \
   --provider ghidra --json
+

+ In Windows Command Prompt, put the command on one line and leave + out the \ characters. +

Replace the target path and main with your own function name or address. Each CLI invocation imports and analyzes