docs(website): add beginner help to the Get started page (#1684)
Add collapsible help sections for installing Node.js, choosing a coding agent, opening a terminal, restarting a client, copying a folder's full path and finding an Electron app's .asar file. Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 5.5
parent
ad3e41d46e
commit
dc676b4d85
@@ -142,8 +142,161 @@
|
||||
terminal.
|
||||
</p>
|
||||
<p class="requirements">
|
||||
You'll need Node.js 22 (22.19+), 24 (24.11+) or 26+, and npm.
|
||||
You'll need Node.js 22 (22.19+), 24 (24.11+) or 26+. npm comes with
|
||||
Node.js.
|
||||
</p>
|
||||
<details class="evidence-details" id="install-node">
|
||||
<summary>Don't have Node.js, or not sure?</summary>
|
||||
<p>Open a terminal and check:</p>
|
||||
<div class="code-block">
|
||||
<div class="code-header">
|
||||
<span>Terminal</span
|
||||
><button
|
||||
class="copy-button"
|
||||
type="button"
|
||||
data-copy="node-check"
|
||||
aria-label="Copy Node.js version check"
|
||||
>
|
||||
Copy
|
||||
</button>
|
||||
</div>
|
||||
<pre><code id="node-check">node -v
|
||||
npm -v</code></pre>
|
||||
</div>
|
||||
<p>
|
||||
If <code>node -v</code> prints v22.19+, v24.11+ or v26+, you're
|
||||
ready. If it prints an older version or "not recognized" / "command
|
||||
not found", install Node.js 24 LTS:
|
||||
</p>
|
||||
<p><strong>Windows (PowerShell)</strong></p>
|
||||
<div class="code-block">
|
||||
<div class="code-header">
|
||||
<span>Windows PowerShell</span
|
||||
><button
|
||||
class="copy-button"
|
||||
type="button"
|
||||
data-copy="node-windows"
|
||||
aria-label="Copy Node.js installation command for Windows"
|
||||
>
|
||||
Copy
|
||||
</button>
|
||||
</div>
|
||||
<pre><code id="node-windows">winget install OpenJS.NodeJS.LTS</code></pre>
|
||||
</div>
|
||||
<p>
|
||||
Type Y if asked to accept the terms. Close PowerShell, open it
|
||||
again, then run <code>node -v</code>.
|
||||
</p>
|
||||
<p>
|
||||
If PowerShell later says
|
||||
<em>"running scripts is disabled on this system"</em> when you run
|
||||
<code>npx</code>, run this once and try again:
|
||||
</p>
|
||||
<div class="code-block">
|
||||
<div class="code-header">
|
||||
<span>Windows PowerShell</span
|
||||
><button
|
||||
class="copy-button"
|
||||
type="button"
|
||||
data-copy="node-windows-policy"
|
||||
aria-label="Copy PowerShell execution policy command"
|
||||
>
|
||||
Copy
|
||||
</button>
|
||||
</div>
|
||||
<pre><code id="node-windows-policy">Set-ExecutionPolicy -Scope CurrentUser RemoteSigned</code></pre>
|
||||
</div>
|
||||
<p><strong>macOS</strong></p>
|
||||
<p>If you use Homebrew:</p>
|
||||
<div class="code-block">
|
||||
<div class="code-header">
|
||||
<span>macOS · Homebrew</span
|
||||
><button
|
||||
class="copy-button"
|
||||
type="button"
|
||||
data-copy="node-macos-brew"
|
||||
aria-label="Copy Homebrew Node.js installation command"
|
||||
>
|
||||
Copy
|
||||
</button>
|
||||
</div>
|
||||
<pre><code id="node-macos-brew">brew install node</code></pre>
|
||||
</div>
|
||||
<p>Otherwise:</p>
|
||||
<div class="code-block">
|
||||
<div class="code-header">
|
||||
<span>macOS</span
|
||||
><button
|
||||
class="copy-button"
|
||||
type="button"
|
||||
data-copy="node-macos-fnm"
|
||||
aria-label="Copy fnm installation command for macOS"
|
||||
>
|
||||
Copy
|
||||
</button>
|
||||
</div>
|
||||
<pre><code id="node-macos-fnm">curl -fsSL https://fnm.vercel.app/install | bash</code></pre>
|
||||
</div>
|
||||
<p>Close Terminal, open it again, then:</p>
|
||||
<div class="code-block">
|
||||
<div class="code-header">
|
||||
<span>macOS</span
|
||||
><button
|
||||
class="copy-button"
|
||||
type="button"
|
||||
data-copy="node-macos-install"
|
||||
aria-label="Copy Node.js 24 commands for macOS"
|
||||
>
|
||||
Copy
|
||||
</button>
|
||||
</div>
|
||||
<pre><code id="node-macos-install">fnm install 24
|
||||
fnm default 24</code></pre>
|
||||
</div>
|
||||
<p><strong>Linux</strong></p>
|
||||
<div class="code-block">
|
||||
<div class="code-header">
|
||||
<span>Linux</span
|
||||
><button
|
||||
class="copy-button"
|
||||
type="button"
|
||||
data-copy="node-linux-fnm"
|
||||
aria-label="Copy fnm installation command for Linux"
|
||||
>
|
||||
Copy
|
||||
</button>
|
||||
</div>
|
||||
<pre><code id="node-linux-fnm">curl -fsSL https://fnm.vercel.app/install | bash</code></pre>
|
||||
</div>
|
||||
<p>
|
||||
The installer needs <code>curl</code> and <code>unzip</code> (on
|
||||
Debian/Ubuntu: <code>sudo apt install curl unzip</code>). Close the
|
||||
terminal, open it again, then:
|
||||
</p>
|
||||
<div class="code-block">
|
||||
<div class="code-header">
|
||||
<span>Linux</span
|
||||
><button
|
||||
class="copy-button"
|
||||
type="button"
|
||||
data-copy="node-linux-install"
|
||||
aria-label="Copy Node.js 24 commands for Linux"
|
||||
>
|
||||
Copy
|
||||
</button>
|
||||
</div>
|
||||
<pre><code id="node-linux-install">fnm install 24
|
||||
fnm default 24</code></pre>
|
||||
</div>
|
||||
<p>
|
||||
Your distribution's own <code>nodejs</code> package is often older
|
||||
than 22.19, so check <code>node -v</code> if you use it instead.
|
||||
</p>
|
||||
<p>
|
||||
Prefer a regular installer? Download the LTS version from
|
||||
<a href="https://nodejs.org/en/download">nodejs.org</a>.
|
||||
</p>
|
||||
</details>
|
||||
</div>
|
||||
<div class="article-layout">
|
||||
<nav class="contents" aria-label="On this page">
|
||||
@@ -164,6 +317,44 @@
|
||||
Build, and other supported MCP clients. Grok Bot's connector is
|
||||
added from its chat.
|
||||
</p>
|
||||
<details class="evidence-details">
|
||||
<summary>New to coding agents?</summary>
|
||||
<p>
|
||||
A coding agent is an AI assistant that works on your computer
|
||||
instead of in a browser tab. It can read files and run commands,
|
||||
and it asks before making changes. REA gives it
|
||||
reverse-engineering tools.
|
||||
</p>
|
||||
<p>
|
||||
If you don't have one yet, pick one, follow its install page and
|
||||
sign in:
|
||||
</p>
|
||||
<ul>
|
||||
<li>
|
||||
<strong
|
||||
><a href="https://code.claude.com/docs/en/setup"
|
||||
>Claude Code</a
|
||||
></strong
|
||||
>
|
||||
by Anthropic. Needs a paid Claude plan.
|
||||
</li>
|
||||
<li>
|
||||
<strong
|
||||
><a href="https://github.com/openai/codex">Codex</a></strong
|
||||
>
|
||||
by OpenAI. Sign in with your ChatGPT account.
|
||||
</li>
|
||||
<li>
|
||||
<strong
|
||||
><a href="https://opencode.ai/docs">OpenCode</a></strong
|
||||
>, open source. Connect the model provider of your choice.
|
||||
</li>
|
||||
</ul>
|
||||
<p>
|
||||
Then open it and copy the prompt below into it. The agent runs
|
||||
REA's setup and shows you the plan before changing anything.
|
||||
</p>
|
||||
</details>
|
||||
<div class="agent-terminal">
|
||||
<div class="terminal-header">
|
||||
<span class="terminal-title"
|
||||
@@ -191,6 +382,28 @@
|
||||
</div>
|
||||
<details class="evidence-details">
|
||||
<summary>Or run setup yourself</summary>
|
||||
<details class="evidence-details">
|
||||
<summary>How do I open a terminal?</summary>
|
||||
<ul>
|
||||
<li>
|
||||
<strong>Windows:</strong> open the Start menu, type
|
||||
<em>PowerShell</em> and press Enter.
|
||||
</li>
|
||||
<li>
|
||||
<strong>macOS:</strong> press <kbd>⌘</kbd> <kbd>Space</kbd>,
|
||||
type <em>Terminal</em> and press Enter.
|
||||
</li>
|
||||
<li>
|
||||
<strong>Linux:</strong> press <kbd>Ctrl</kbd> <kbd>Alt</kbd>
|
||||
<kbd>T</kbd> on most desktops.
|
||||
</li>
|
||||
</ul>
|
||||
<p>
|
||||
Paste a command with <kbd>Ctrl</kbd> <kbd>V</kbd> (macOS:
|
||||
<kbd>⌘</kbd> <kbd>V</kbd>; Linux terminals: <kbd>Ctrl</kbd>
|
||||
<kbd>Shift</kbd> <kbd>V</kbd>), then press Enter.
|
||||
</p>
|
||||
</details>
|
||||
<div class="code-block">
|
||||
<div class="code-header">
|
||||
<span>Terminal</span
|
||||
@@ -211,10 +424,24 @@
|
||||
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.</p>
|
||||
<details class="evidence-details">
|
||||
<summary>How do I restart my client?</summary>
|
||||
<p>
|
||||
<strong>Desktop apps</strong> (Claude Desktop, Cursor, Windsurf,
|
||||
VS Code): quit the app completely, then open it again. Closing
|
||||
the window isn't enough. On macOS press <kbd>⌘</kbd>
|
||||
<kbd>Q</kbd>; on Windows, also quit from the tray icon if there
|
||||
is one.
|
||||
</p>
|
||||
<p>
|
||||
<strong>Terminal agents</strong> (Claude Code, Codex, Gemini
|
||||
CLI): exit the session and start it again.
|
||||
</p>
|
||||
</details>
|
||||
<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:
|
||||
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>
|
||||
@@ -224,6 +451,27 @@
|
||||
</p>
|
||||
</blockquote>
|
||||
<p>Replace the path with your local target.</p>
|
||||
<details class="evidence-details">
|
||||
<summary>How do I get a folder's full path?</summary>
|
||||
<ul>
|
||||
<li>
|
||||
<strong>Windows:</strong> in File Explorer, right-click the
|
||||
folder and choose <em>Copy as path</em>. On Windows 10, hold
|
||||
Shift while right-clicking.
|
||||
</li>
|
||||
<li>
|
||||
<strong>macOS:</strong> in Finder, right-click the folder,
|
||||
hold Option and choose <em>Copy "…" as Pathname</em>.
|
||||
</li>
|
||||
<li>
|
||||
<strong>Any system:</strong> drag the folder into a terminal
|
||||
window and its path appears.
|
||||
</li>
|
||||
</ul>
|
||||
<p>
|
||||
In a terminal, put quotes around a path that contains spaces.
|
||||
</p>
|
||||
</details>
|
||||
</section>
|
||||
|
||||
<section class="article-section" id="terminal">
|
||||
@@ -252,6 +500,37 @@
|
||||
<code>.asar</code> file. On Windows, a path such as
|
||||
<code>"D:/apps/example"</code> works here.
|
||||
</p>
|
||||
<details class="evidence-details">
|
||||
<summary>Where do I find an app's .asar file?</summary>
|
||||
<p>
|
||||
Electron apps usually keep it in a
|
||||
<code>resources</code> folder:
|
||||
</p>
|
||||
<ul>
|
||||
<li>
|
||||
<strong>Windows:</strong>
|
||||
<code
|
||||
>C:\Users\<you>\AppData\Local\Programs\<App>\resources\app.asar</code
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<strong>macOS:</strong>
|
||||
<code
|
||||
>/Applications/<App>.app/Contents/Resources/app.asar</code
|
||||
>
|
||||
(right-click the app and choose
|
||||
<em>Show Package Contents</em>)
|
||||
</li>
|
||||
<li>
|
||||
<strong>Linux:</strong> often
|
||||
<code>/opt/<App>/resources/app.asar</code>
|
||||
</li>
|
||||
</ul>
|
||||
<p>
|
||||
Some apps install elsewhere. Search the app's folder for
|
||||
<code>app.asar</code>.
|
||||
</p>
|
||||
</details>
|
||||
<p>
|
||||
The result identifies the app, shows connections between modules
|
||||
and gives their source locations. Connections REA cannot resolve
|
||||
|
||||
Reference in New Issue
Block a user