Installer internals
OpenClaw ships three installer scripts, served fromopenclaw.ai.
| Script | Platform | What it does |
|---|---|---|
install.sh | macOS / Linux / WSL | Installs Node if needed, installs OpenClaw via npm (default) or git, and can run onboarding. |
install-cli.sh | macOS / Linux / WSL | Installs Node + OpenClaw into a local prefix (~/.openclaw). No root required. |
install.ps1 | Windows (PowerShell) | Installs Node if needed, installs OpenClaw via npm (default) or git, and can run onboarding. |
Quick commands
- install.sh
- install-cli.sh
- install.ps1
If install succeeds but
openclaw is not found in a new terminal, see Node.js troubleshooting.install.sh
Flow (install.sh)
Detect OS
Supports macOS and Linux (including WSL). If macOS is detected, installs Homebrew if missing.
Ensure Node.js 22+
Checks Node version and installs Node 22 if needed (Homebrew on macOS, NodeSource setup scripts on Linux apt/dnf/yum).
Install OpenClaw
npmmethod (default): global npm installgitmethod: clone/update repo, install deps with pnpm, build, then install wrapper at~/.local/bin/openclaw
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)
npm and warns.
The script exits with code 2 for invalid method selection or invalid --install-method values.
Examples (install.sh)
- Default
- Skip onboarding
- Git install
- Dry run
Flags reference
Flags reference
| Flag | Description |
|---|---|
--install-method npm|git | Choose install method (default: npm). Alias: --method |
--npm | Shortcut for npm method |
--git | Shortcut for git method. Alias: --github |
--version <version|dist-tag> | npm version or dist-tag (default: latest) |
--beta | Use beta dist-tag if available, else fallback to latest |
--git-dir <path> | Checkout directory (default: ~/openclaw). Alias: --dir |
--no-git-update | Skip git pull for existing checkout |
--no-prompt | Disable prompts |
--no-onboard | Skip onboarding |
--onboard | Enable onboarding |
--dry-run | Print actions without applying changes |
--verbose | Enable debug output (set -x, npm notice-level logs) |
--help | Show usage (-h) |
Environment variables reference
Environment variables reference
| Variable | Description |
|---|---|
OPENCLAW_INSTALL_METHOD=git|npm | Install method |
OPENCLAW_VERSION=latest|next|<semver> | npm version or dist-tag |
OPENCLAW_BETA=0|1 | Use beta if available |
OPENCLAW_GIT_DIR=<path> | Checkout directory |
OPENCLAW_GIT_UPDATE=0|1 | Toggle git updates |
OPENCLAW_NO_PROMPT=1 | Disable prompts |
OPENCLAW_NO_ONBOARD=1 | Skip onboarding |
OPENCLAW_DRY_RUN=1 | Dry run mode |
OPENCLAW_VERBOSE=1 | Debug mode |
OPENCLAW_NPM_LOGLEVEL=error|warn|notice | npm log level |
SHARP_IGNORE_GLOBAL_LIBVIPS=0|1 | Control sharp/libvips behavior (default: 1) |
install-cli.sh
Designed for environments where you want everything under a local prefix (default
~/.openclaw) and no system Node dependency.Flow (install-cli.sh)
Install local Node runtime
Downloads Node tarball (default
22.22.0) to <prefix>/tools/node-v<version> and verifies SHA-256.Examples (install-cli.sh)
- Default
- Custom prefix + version
- Automation JSON output
- Run onboarding
Flags reference
Flags reference
| Flag | Description |
|---|---|
--prefix <path> | Install prefix (default: ~/.openclaw) |
--version <ver> | OpenClaw version or dist-tag (default: latest) |
--node-version <ver> | Node version (default: 22.22.0) |
--json | Emit NDJSON events |
--onboard | Run openclaw onboard after install |
--no-onboard | Skip onboarding (default) |
--set-npm-prefix | On Linux, force npm prefix to ~/.npm-global if current prefix is not writable |
--help | Show usage (-h) |
Environment variables reference
Environment variables reference
| 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 (install.ps1)
Install OpenClaw
npmmethod (default): global npm install using selected-Taggitmethod: clone/update repo, install/build with pnpm, and install wrapper at%USERPROFILE%\.local\bin\openclaw.cmd
Examples (install.ps1)
- Default
- Git install
- Custom git directory
- Dry run
Flags reference
Flags reference
| Flag | Description |
|---|---|
-InstallMethod npm|git | Install method (default: npm) |
-Tag <tag> | npm dist-tag (default: latest) |
-GitDir <path> | Checkout directory (default: %USERPROFILE%\openclaw) |
-NoOnboard | Skip onboarding |
-NoGitUpdate | Skip git pull |
-DryRun | Print actions only |
Environment variables reference
Environment variables reference
| Variable | Description |
|---|---|
OPENCLAW_INSTALL_METHOD=git|npm | Install method |
OPENCLAW_GIT_DIR=<path> | Checkout directory |
OPENCLAW_NO_ONBOARD=1 | Skip onboarding |
OPENCLAW_GIT_UPDATE=0 | Disable git pull |
OPENCLAW_DRY_RUN=1 | Dry run mode |
If
-InstallMethod git is used and Git is missing, the script exits and prints the Git for Windows link.CI and automation
Use non-interactive flags/env vars for predictable runs.- install.sh (non-interactive npm)
- install.sh (non-interactive git)
- install-cli.sh (JSON)
- install.ps1 (skip onboarding)
Troubleshooting
Why is Git required?
Why is Git required?
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.Why does npm hit EACCES on Linux?
Why does npm hit EACCES on Linux?
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).sharp/libvips issues
sharp/libvips issues
Windows: "npm error spawn git / ENOENT"
Windows: "npm error spawn git / ENOENT"
Install Git for Windows, reopen PowerShell, rerun installer.
Windows: "openclaw is not recognized"
Windows: "openclaw is not recognized"
Run
npm config get prefix, append \bin, add that directory to user PATH, then reopen PowerShell.openclaw not found after install
openclaw not found after install
Usually a PATH issue. See Node.js troubleshooting.