{ "title": "Install", "content": "Use the installer unless you have a reason not to. It sets up the CLI and runs onboarding.\n\n## Quick install (recommended)\n\nWindows (PowerShell):\n\nNext step (if you skipped onboarding):\n\n## System requirements\n\n* **Node >=22**\n* macOS, Linux, or Windows via WSL2\n* `pnpm` only if you build from source\n\n## Choose your install path\n\n### 1) Installer script (recommended)\n\nInstalls `openclaw` globally via npm and runs onboarding.\n\nDetails: [Installer internals](/install/installer).\n\nNon-interactive (skip onboarding):\n\n### 2) Global install (manual)\n\nIf you already have Node:\n\nIf you have libvips installed globally (common on macOS via Homebrew) and `sharp` fails to install, force prebuilt binaries:\n\nIf you see `sharp: Please add node-gyp to your dependencies`, either install build tooling (macOS: Xcode CLT + `npm install -g node-gyp`) or use the `SHARP_IGNORE_GLOBAL_LIBVIPS=1` workaround above to skip the native build.\n\npnpm requires explicit approval for packages with build scripts. After the first install shows the \"Ignored build scripts\" warning, run `pnpm approve-builds -g` and select the listed packages.\n\n### 3) From source (contributors/dev)\n\nTip: if you don’t have a global install yet, run repo commands via `pnpm openclaw ...`.\n\n### 4) Other install options\n\n* Docker: [Docker](/install/docker)\n* Nix: [Nix](/install/nix)\n* Ansible: [Ansible](/install/ansible)\n* Bun (CLI only): [Bun](/install/bun)\n\n* Run onboarding: `openclaw onboard --install-daemon`\n* Quick check: `openclaw doctor`\n* Check gateway health: `openclaw status` + `openclaw health`\n* Open the dashboard: `openclaw dashboard`\n\n## Install method: npm vs git (installer)\n\nThe installer supports two methods:\n\n* `npm` (default): `npm install -g openclaw@latest`\n* `git`: clone/build from GitHub and run from a source checkout", "code_samples": [ { "code": "Windows (PowerShell):", "language": "unknown" }, { "code": "Next step (if you skipped onboarding):", "language": "unknown" }, { "code": "## System requirements\n\n* **Node >=22**\n* macOS, Linux, or Windows via WSL2\n* `pnpm` only if you build from source\n\n## Choose your install path\n\n### 1) Installer script (recommended)\n\nInstalls `openclaw` globally via npm and runs onboarding.", "language": "unknown" }, { "code": "Installer flags:", "language": "unknown" }, { "code": "Details: [Installer internals](/install/installer).\n\nNon-interactive (skip onboarding):", "language": "unknown" }, { "code": "### 2) Global install (manual)\n\nIf you already have Node:", "language": "unknown" }, { "code": "If you have libvips installed globally (common on macOS via Homebrew) and `sharp` fails to install, force prebuilt binaries:", "language": "unknown" }, { "code": "If you see `sharp: Please add node-gyp to your dependencies`, either install build tooling (macOS: Xcode CLT + `npm install -g node-gyp`) or use the `SHARP_IGNORE_GLOBAL_LIBVIPS=1` workaround above to skip the native build.\n\nOr with pnpm:", "language": "unknown" }, { "code": "pnpm requires explicit approval for packages with build scripts. After the first install shows the \"Ignored build scripts\" warning, run `pnpm approve-builds -g` and select the listed packages.\n\nThen:", "language": "unknown" }, { "code": "### 3) From source (contributors/dev)", "language": "unknown" }, { "code": "Tip: if you don’t have a global install yet, run repo commands via `pnpm openclaw ...`.\n\n### 4) Other install options\n\n* Docker: [Docker](/install/docker)\n* Nix: [Nix](/install/nix)\n* Ansible: [Ansible](/install/ansible)\n* Bun (CLI only): [Bun](/install/bun)\n\n## After install\n\n* Run onboarding: `openclaw onboard --install-daemon`\n* Quick check: `openclaw doctor`\n* Check gateway health: `openclaw status` + `openclaw health`\n* Open the dashboard: `openclaw dashboard`\n\n## Install method: npm vs git (installer)\n\nThe installer supports two methods:\n\n* `npm` (default): `npm install -g openclaw@latest`\n* `git`: clone/build from GitHub and run from a source checkout\n\n### CLI flags", "language": "unknown" } ], "headings": [ { "level": "h2", "text": "Quick install (recommended)", "id": "quick-install-(recommended)" }, { "level": "h2", "text": "System requirements", "id": "system-requirements" }, { "level": "h2", "text": "Choose your install path", "id": "choose-your-install-path" }, { "level": "h3", "text": "1) Installer script (recommended)", "id": "1)-installer-script-(recommended)" }, { "level": "h3", "text": "2) Global install (manual)", "id": "2)-global-install-(manual)" }, { "level": "h3", "text": "3) From source (contributors/dev)", "id": "3)-from-source-(contributors/dev)" }, { "level": "h3", "text": "4) Other install options", "id": "4)-other-install-options" }, { "level": "h2", "text": "After install", "id": "after-install" }, { "level": "h2", "text": "Install method: npm vs git (installer)", "id": "install-method:-npm-vs-git-(installer)" }, { "level": "h3", "text": "CLI flags", "id": "cli-flags" } ], "url": "llms-txt#install", "links": [] }