* docs(install): revamp installer internals for readability and accuracy
Restructure the installer internals page with better flow and Mintlify
components (CardGroup, Steps, Tabs, AccordionGroup). All flags, env vars,
and behavioral descriptions cross-checked against install.sh,
install-cli.sh, and install.ps1 source code.
- Add CardGroup chooser and Quick Commands section at top
- Organize each script into consistent Flow → Examples → Reference pattern
- Move flags/env var tables into collapsible Accordions
- Consolidate troubleshooting into AccordionGroup at bottom
- Add missing flags (--version, --beta, --verbose, --help, etc.)
- Add missing env vars (OPENCLAW_VERSION, OPENCLAW_BETA, etc.)
- Document install-cli.sh fully (was one paragraph)
- Fix non-interactive checkout detection behavior (defaults to npm)
- Use --proto/--tlsv1.2 in curl examples to match script usage
- No content deleted; all original info preserved or relocated
* fix(docs): correct in-page anchor hrefs for installer cards
* docs(install): replace CardGroup with table for installer overview
If install succeeds but `openclaw` is not found in a new terminal, see [Node.js troubleshooting](/install/node#troubleshooting).
install.sh
Recommended for most interactive installs on macOS/Linux/WSL.
Flow
Supports macOS and Linux (including WSL). If macOS is detected, installs Homebrew if missing.
Checks Node version and installs Node 22 if needed (Homebrew on macOS, NodeSource setup scripts on Linux apt/dnf/yum).
Installs Git if missing.
- `npm` method (default): global npm install
- `git` method: clone/update repo, install deps with pnpm, build, then install wrapper at `~/.local/bin/openclaw`
- Runs `openclaw doctor --non-interactive` on upgrades and git installs (best effort)
- Attempts onboarding when appropriate (TTY available, onboarding not disabled, and bootstrap/config checks pass)
- Defaults `SHARP_IGNORE_GLOBAL_LIBVIPS=1`
Source checkout detection
If run inside an OpenClaw checkout (package.json + pnpm-workspace.yaml), the script offers:
use checkout (git), or
use global install (npm)
If no TTY is available and no install method is set, it defaults to npm and warns.
The script exits with code 2 for invalid method selection or invalid --install-method values.
Designed for environments where you want everything under a local prefix (default `~/.openclaw`) and no system Node dependency.
Flow
Downloads Node tarball (default `22.22.0`) to `/tools/node-v` and verifies SHA-256.
If Git is missing, attempts install via apt/dnf/yum on Linux or Homebrew on macOS.
Installs with npm using `--prefix `, then writes wrapper to `/bin/openclaw`.
On Linux, force npm prefix to ~/.npm-global if current prefix is not writable
--help
Show usage (-h)
Variable
Description
OPENCLAW_PREFIX=<path>
Install prefix
OPENCLAW_VERSION=<ver>
OpenClaw version or dist-tag
OPENCLAW_NODE_VERSION=<ver>
Node version
OPENCLAW_NO_ONBOARD=1
Skip onboarding
OPENCLAW_NPM_LOGLEVEL=error|warn|notice
npm log level
OPENCLAW_GIT_DIR=<path>
Legacy cleanup lookup path (used when removing old Peekaboo submodule checkout)
SHARP_IGNORE_GLOBAL_LIBVIPS=0|1
Control sharp/libvips behavior (default: 1)
install.ps1
Flow
Requires PowerShell 5+.
If missing, attempts install via winget, then Chocolatey, then Scoop.
- `npm` method (default): global npm install using selected `-Tag`
- `git` method: clone/update repo, install/build with pnpm, and install wrapper at `%USERPROFILE%\.local\bin\openclaw.cmd`
Adds needed bin directory to user PATH when possible, then runs `openclaw doctor --non-interactive` on upgrades and git installs (best effort).
Git is required for `git` install method. For `npm` installs, Git is still checked/installed to avoid `spawn git ENOENT` failures when dependencies use git URLs.
Some Linux setups point npm global prefix to root-owned paths. `install.sh` can switch prefix to `~/.npm-global` and append PATH exports to shell rc files (when those files exist).
The scripts default `SHARP_IGNORE_GLOBAL_LIBVIPS=1` to avoid sharp building against system libvips. To override:
Install Git for Windows, reopen PowerShell, rerun installer.
Run `npm config get prefix`, append `\bin`, add that directory to user PATH, then reopen PowerShell.
Usually a PATH issue. See [Node.js troubleshooting](/install/node#troubleshooting).