Some checks failed
ClawSweeper Dispatch / dispatch (push) Has been cancelled
CodeQL / Security High (actions) (push) Has been cancelled
CodeQL / Security High (channel-runtime-boundary) (push) Has been cancelled
CodeQL / Security High (core-auth-secrets) (push) Has been cancelled
CodeQL / Security High (mcp-process-tool-boundary) (push) Has been cancelled
CodeQL / Security High (network-ssrf-boundary) (push) Has been cancelled
CodeQL / Security High (plugin-trust-boundary) (push) Has been cancelled
CodeQL / Security High (process-exec-boundary) (push) Has been cancelled
Docs Sync Publish Repo / sync-publish-repo (push) Has been cancelled
Docs / docs (push) Has been cancelled
OpenClaw Stable Main Closeout / Resolve stable release closeout inputs (push) Has been cancelled
OpenClaw Stable Main Closeout / Verify stable main closeout (push) Has been cancelled
Workflow Sanity / no-tabs (push) Has been cancelled
Workflow Sanity / actionlint (push) Has been cancelled
Workflow Sanity / generated-doc-baselines (push) Has been cancelled
CI / runner-admission (push) Has been cancelled
CI / preflight (push) Has been cancelled
CI / security-fast (push) Has been cancelled
CI / pnpm-store-warmup (push) Has been cancelled
CI / build-artifacts (push) Has been cancelled
CI / native-i18n (push) Has been cancelled
CI / ${{ matrix.check_name }} (push) Has been cancelled
CI / ${{ matrix.checkName }} (push) Has been cancelled
CI / checks-node-compat-node22 (push) Has been cancelled
CI / check-bundled-channel-config-metadata (push) Has been cancelled
CI / check-dependencies (push) Has been cancelled
CI / check-guards (push) Has been cancelled
CI / check-lint (push) Has been cancelled
CI / check-prod-types (push) Has been cancelled
CI / check-shrinkwrap (push) Has been cancelled
CI / check-test-types (push) Has been cancelled
CI / check-additional-boundaries-a (push) Has been cancelled
CI / check-additional-boundaries-bcd (push) Has been cancelled
CI / check-additional-extension-bundled (push) Has been cancelled
CI / check-additional-extension-channels (push) Has been cancelled
CI / check-additional-extension-package-boundary (push) Has been cancelled
CI / check-additional-runtime-topology-architecture (push) Has been cancelled
CI / check-session-accessor-boundary (push) Has been cancelled
CI / check-session-transcript-reader-boundary (push) Has been cancelled
CI / check-docs (push) Has been cancelled
CI / skills-python (push) Has been cancelled
CI / macos-swift (push) Has been cancelled
CI / ios-build (push) Has been cancelled
CI / ci-timings-summary (push) Has been cancelled
Native App Locale Refresh / Refresh native fa (push) Has been cancelled
Native App Locale Refresh / Refresh native fr (push) Has been cancelled
Native App Locale Refresh / Refresh native hi (push) Has been cancelled
Native App Locale Refresh / Refresh native id (push) Has been cancelled
Native App Locale Refresh / Refresh native it (push) Has been cancelled
Native App Locale Refresh / Refresh native ja-JP (push) Has been cancelled
Control UI Locale Refresh / plan (push) Has been cancelled
Control UI Locale Refresh / Refresh ${{ matrix.locale }} (push) Has been cancelled
Control UI Locale Refresh / Commit control UI locale refresh (push) Has been cancelled
Live Media Runner Image / Build live media runner image (push) Has been cancelled
Native App Locale Refresh / Refresh native ar (push) Has been cancelled
Native App Locale Refresh / Refresh native de (push) Has been cancelled
Native App Locale Refresh / Refresh native es (push) Has been cancelled
Native App Locale Refresh / Refresh native ko (push) Has been cancelled
Native App Locale Refresh / Refresh native nl (push) Has been cancelled
Native App Locale Refresh / Refresh native pl (push) Has been cancelled
Native App Locale Refresh / Refresh native pt-BR (push) Has been cancelled
Native App Locale Refresh / Refresh native ru (push) Has been cancelled
Native App Locale Refresh / Refresh native sv (push) Has been cancelled
Native App Locale Refresh / Refresh native th (push) Has been cancelled
Native App Locale Refresh / Refresh native tr (push) Has been cancelled
Native App Locale Refresh / Refresh native uk (push) Has been cancelled
Native App Locale Refresh / Refresh native vi (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-CN (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-TW (push) Has been cancelled
Native App Locale Refresh / Commit native locale refresh (push) Has been cancelled
Plugin Init Scaffold Validation / Validate provider scaffold (push) Has been cancelled
Plugin NPM Release / preview_plugins_npm (push) Has been cancelled
Plugin NPM Release / Validate release publish approval (push) Has been cancelled
Plugin NPM Release / preview_plugin_pack (push) Has been cancelled
Plugin NPM Release / publish_plugins_npm (push) Has been cancelled
Sandbox Common Smoke / sandbox-common-smoke (push) Has been cancelled
Website Installer Sync / static (push) Has been cancelled
Website Installer Sync / linux-docker (push) Has been cancelled
Website Installer Sync / macos-installer (push) Has been cancelled
Website Installer Sync / windows-installer (push) Has been cancelled
Website Installer Sync / sync-website (push) Has been cancelled
Adolf is a fork/vendored clone of github.com/openclaw/openclaw (v2026.6.11), free to diverge. Tree copied sans upstream .git; upstream remote added for future syncs. Node pinned to 24 (.nvmrc); engines already require >=22.19. Preserves docs/ARCHITECTURE.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LeqyaxJF2nbRXJtae2kNB2
143 lines
3.9 KiB
Markdown
143 lines
3.9 KiB
Markdown
---
|
|
summary: "Install and configure Node.js for OpenClaw - version requirements, install options, and PATH troubleshooting"
|
|
title: "Node.js"
|
|
read_when:
|
|
- "You need to install Node.js before installing OpenClaw"
|
|
- "You installed OpenClaw but `openclaw` is command not found"
|
|
- "npm install -g fails with permissions or PATH issues"
|
|
---
|
|
|
|
OpenClaw requires **Node 22.19+, Node 23.11+, or Node 24+**. **Node 24 is the default and recommended runtime** for installs, CI, and release workflows; Node 22 remains supported via the active LTS line. The [installer script](/install#alternative-install-methods) detects and installs Node automatically — use this page when you want to set up Node yourself (versions, PATH, global installs).
|
|
|
|
## Check your version
|
|
|
|
```bash
|
|
node -v
|
|
```
|
|
|
|
`v24.x.x` or higher is the recommended default. `v22.19.x` or higher is the supported Node 22 LTS path (upgrade to Node 24 when convenient). Node 23 builds before `v23.11.0` are unsupported. If Node is missing or outside the supported range, pick an install method below.
|
|
|
|
## Install Node
|
|
|
|
<Tabs>
|
|
<Tab title="macOS">
|
|
**Homebrew** (recommended):
|
|
|
|
```bash
|
|
brew install node
|
|
```
|
|
|
|
Or download the macOS installer from [nodejs.org](https://nodejs.org/).
|
|
|
|
</Tab>
|
|
<Tab title="Linux">
|
|
**Ubuntu / Debian:**
|
|
|
|
```bash
|
|
curl -fsSL https://deb.nodesource.com/setup_24.x | sudo -E bash -
|
|
sudo apt-get install -y nodejs
|
|
```
|
|
|
|
**Fedora / RHEL:**
|
|
|
|
```bash
|
|
sudo dnf install nodejs
|
|
```
|
|
|
|
Or use a version manager (see below).
|
|
|
|
</Tab>
|
|
<Tab title="Windows">
|
|
**winget** (recommended):
|
|
|
|
```powershell
|
|
winget install OpenJS.NodeJS.LTS
|
|
```
|
|
|
|
**Chocolatey:**
|
|
|
|
```powershell
|
|
choco install nodejs-lts
|
|
```
|
|
|
|
Or download the Windows installer from [nodejs.org](https://nodejs.org/).
|
|
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
<Accordion title="Using a version manager (nvm, fnm, mise, asdf)">
|
|
Version managers let you switch between Node versions easily. Popular options:
|
|
|
|
- [**fnm**](https://github.com/Schniz/fnm) - fast, cross-platform
|
|
- [**nvm**](https://github.com/nvm-sh/nvm) - widely used on macOS/Linux
|
|
- [**mise**](https://mise.jdx.dev/) - polyglot (Node, Python, Ruby, etc.)
|
|
|
|
Example with fnm:
|
|
|
|
```bash
|
|
fnm install 24
|
|
fnm use 24
|
|
```
|
|
|
|
<Warning>
|
|
Initialize your version manager in your shell startup file (`~/.zshrc` or `~/.bashrc`). If you skip this, `openclaw` may not be found in new terminal sessions because PATH won't include Node's bin directory.
|
|
</Warning>
|
|
</Accordion>
|
|
|
|
## Troubleshooting
|
|
|
|
### `openclaw: command not found`
|
|
|
|
This almost always means npm's global bin directory isn't on your PATH.
|
|
|
|
<Steps>
|
|
<Step title="Find your global npm prefix">
|
|
```bash
|
|
npm prefix -g
|
|
```
|
|
</Step>
|
|
<Step title="Check if it's on your PATH">
|
|
```bash
|
|
echo "$PATH"
|
|
```
|
|
|
|
Look for `<npm-prefix>/bin` (macOS/Linux) or `<npm-prefix>` (Windows) in the output.
|
|
|
|
</Step>
|
|
<Step title="Add it to your shell startup file">
|
|
<Tabs>
|
|
<Tab title="macOS / Linux">
|
|
Add to `~/.zshrc` or `~/.bashrc`:
|
|
|
|
```bash
|
|
export PATH="$(npm prefix -g)/bin:$PATH"
|
|
```
|
|
|
|
Then open a new terminal (or run `rehash` in zsh / `hash -r` in bash).
|
|
</Tab>
|
|
<Tab title="Windows">
|
|
Add the output of `npm prefix -g` to your system PATH via Settings → System → Environment Variables.
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
</Step>
|
|
</Steps>
|
|
|
|
### Permission errors on `npm install -g` (Linux)
|
|
|
|
If you see `EACCES` errors, switch npm's global prefix to a user-writable directory:
|
|
|
|
```bash
|
|
mkdir -p "$HOME/.npm-global"
|
|
npm config set prefix "$HOME/.npm-global"
|
|
export PATH="$HOME/.npm-global/bin:$PATH"
|
|
```
|
|
|
|
Add the `export PATH=...` line to your `~/.bashrc` or `~/.zshrc` to make it permanent.
|
|
|
|
## Related
|
|
|
|
- [Install Overview](/install) - all installation methods
|
|
- [Updating](/install/updating) - keeping OpenClaw up to date
|
|
- [Getting Started](/start/getting-started) - first steps after install
|